object Reads extends ConstraintReads with PathReads with DefaultReads with GeneratedReads

Default deserializer type classes.

Source
Reads.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Reads
  2. GeneratedReads
  3. DefaultReads
  4. LowPriorityDefaultReads
  5. EnvReads
  6. PathReads
  7. ConstraintReads
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class UUIDReader extends [UUID]

    Deserializer for java.util.UUID

    Deserializer for java.util.UUID

    Definition Classes
    DefaultReads
  2. trait TemporalParser[T <: Temporal] extends AnyRef

    Typeclass to implement way of parsing string as Java8 temporal types.

    Typeclass to implement way of parsing string as Java8 temporal types.

    Definition Classes
    EnvReads

Value Members

  1. implicit object BigIntReads extends Reads[BigInt]

    Deserializer for BigInt

    Deserializer for BigInt

    Definition Classes
    DefaultReads
  2. implicit object BigIntegerReads extends [BigInteger]

    Deserializer for BigInteger

    Deserializer for BigInteger

    Definition Classes
    DefaultReads
  3. implicit object BooleanReads extends Reads[Boolean]

    Deserializer for Boolean types.

    Deserializer for Boolean types.

    Definition Classes
    DefaultReads
  4. implicit object ByteReads extends Reads[Byte]

    Deserializer for Byte types.

    Deserializer for Byte types.

    Definition Classes
    DefaultReads
  5. implicit object DoubleReads extends Reads[Double]

    Deserializer for Double types.

    Deserializer for Double types.

    Definition Classes
    DefaultReads
  6. implicit object FloatReads extends Reads[Float]

    Deserializer for Float types.

    Deserializer for Float types.

    Definition Classes
    DefaultReads
  7. implicit object IntReads extends Reads[Int]

    Deserializer for Int types.

    Deserializer for Int types.

    Definition Classes
    DefaultReads
  8. implicit object JsArrayReads extends [JsArray]

    Deserializer for JsArray.

    Deserializer for JsArray.

    Definition Classes
    DefaultReads
  9. implicit object JsBooleanReads extends [JsBoolean]

    Deserializer for JsBoolean.

    Deserializer for JsBoolean.

    Definition Classes
    DefaultReads
  10. implicit object JsNumberReads extends [JsNumber]

    Deserializer for JsNumber.

    Deserializer for JsNumber.

    Definition Classes
    DefaultReads
  11. implicit object JsObjectReads extends [JsObject]

    Deserializer for JsObject.

    Deserializer for JsObject.

    Definition Classes
    DefaultReads
  12. implicit object JsStringReads extends [JsString]

    Deserializer for JsString.

    Deserializer for JsString.

    Definition Classes
    DefaultReads
  13. implicit object JsValueReads extends [JsValue]

    Deserializer for JsValue.

    Deserializer for JsValue.

    Definition Classes
    DefaultReads
  14. implicit object LongReads extends Reads[Long]

    Deserializer for Long types.

    Deserializer for Long types.

    Definition Classes
    DefaultReads
  15. implicit object ShortReads extends Reads[Short]

    Deserializer for Short types.

    Deserializer for Short types.

    Definition Classes
    DefaultReads
  16. implicit object StringReads extends Reads[String]

    Deserializer for String types.

    Deserializer for String types.

    Definition Classes
    DefaultReads
  17. implicit object ArrayNodeReads extends Reads[ArrayNode]

    Deserializer for Jackson ArrayNode

    Deserializer for Jackson ArrayNode

    Definition Classes
    EnvReads
  18. object IsoDateReads extends [Date]

    ISO 8601 Reads

    ISO 8601 Reads

    Definition Classes
    EnvReads
  19. implicit object JsonNodeReads extends Reads[JsonNode]

    Deserializer for Jackson JsonNode

    Deserializer for Jackson JsonNode

    Definition Classes
    EnvReads
  20. implicit object ObjectNodeReads extends Reads[ObjectNode]

    Deserializer for Jackson ObjectNode

    Deserializer for Jackson ObjectNode

    Definition Classes
    EnvReads
  21. object TemporalParser

    Parsing companion

    Parsing companion

    Definition Classes
    EnvReads
  22. implicit def ArrayReads[T](implicit arg0: Reads[T], arg1: ClassTag[T]): Reads[Array[T]]

    Deserializer for Array[T] types.

    Deserializer for Array[T] types.

    Definition Classes
    DefaultReads
  23. implicit val DefaultDateReads: [Date]

    the default implicit java.util.Date reads

    the default implicit java.util.Date reads

    Definition Classes
    EnvReads
  24. implicit val DefaultInstantReads: [Instant]

    The default typeclass to reads java.time.Instant from JSON.

    The default typeclass to reads java.time.Instant from JSON. Accepts instant formats as '2011-12-03T10:15:30Z', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

    Definition Classes
    EnvReads
  25. implicit val DefaultJavaDurationReads: [Duration]

    Deserializer of Java Duration, from either a time-based amount of time (string representation such as '34.5 seconds'), or from a number of milliseconds (see javaDurationMillisReads).

    Deserializer of Java Duration, from either a time-based amount of time (string representation such as '34.5 seconds'), or from a number of milliseconds (see javaDurationMillisReads).

    Definition Classes
    EnvReads
    See also

    java.time.Duration

    if you want to use java.time.Period instead.

  26. implicit val DefaultJavaPeriodReads: [Period]

    Deserializer of Java Period, from either a time-based amount of time in the ISO-8601 calendar system, such as '2 years, 3 months and 4 days' or from a number of days (see javaPeriodDaysReads).

    Deserializer of Java Period, from either a time-based amount of time in the ISO-8601 calendar system, such as '2 years, 3 months and 4 days' or from a number of days (see javaPeriodDaysReads).

    Definition Classes
    EnvReads
    See also

    java.time.Period

    if you want to use java.time.Duration instead.

  27. implicit val DefaultLocalDateReads: [LocalDate]

    The default typeclass to reads java.time.LocalDate from JSON.

    The default typeclass to reads java.time.LocalDate from JSON. Accepts date formats as '2011-12-03'.

    Definition Classes
    EnvReads
  28. implicit val DefaultLocalDateTimeReads: [LocalDateTime]

    The default typeclass to reads java.time.LocalDateTime from JSON.

    The default typeclass to reads java.time.LocalDateTime from JSON. Accepts date/time formats as '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

    Definition Classes
    EnvReads
  29. implicit val DefaultLocalTimeReads: [LocalTime]

    The default typeclass to reads java.time.LocalTime from JSON.

    The default typeclass to reads java.time.LocalTime from JSON. Accepts date formats as '10:15:30' (or '10:15').

    Definition Classes
    EnvReads
  30. implicit val DefaultOffsetDateTimeReads: [OffsetDateTime]

    The default typeclass to reads java.time.OffsetDateTime from JSON.

    The default typeclass to reads java.time.OffsetDateTime from JSON. Accepts date/time formats as '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

    Definition Classes
    EnvReads
  31. implicit val DefaultSqlDateReads: [Date]

    the default implicit SqlDate reads

    the default implicit SqlDate reads

    Definition Classes
    EnvReads
  32. implicit val DefaultZonedDateTimeReads: [ZonedDateTime]

    The default typeclass to reads java.time.ZonedDateTime from JSON.

    The default typeclass to reads java.time.ZonedDateTime from JSON. Accepts date/time formats as '2011-12-03T10:15:30', '2011-12-03T10:15:30+01:00' or '2011-12-03T10:15:30+01:00[Europe/Paris]'.

    Definition Classes
    EnvReads
  33. implicit val JsArrayReducer: [, JsArray]
  34. def JsErrorObj(knownValue: JsValue, key: String, args: JsValue*): JsObject

    builds a JsErrorObj JsObject { VAL : "current known erroneous jsvalue", ERR : "the i18n key of the error msg", ARGS : "the args for the error msg" (JsArray) }

    builds a JsErrorObj JsObject { VAL : "current known erroneous jsvalue", ERR : "the i18n key of the error msg", ARGS : "the args for the error msg" (JsArray) }

    Definition Classes
    DefaultReads
  35. implicit val JsObjectReducer: [, JsObject]
  36. implicit def Tuple10R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)]
    Definition Classes
    GeneratedReads
  37. implicit def Tuple11R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)]
    Definition Classes
    GeneratedReads
  38. implicit def Tuple12R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)]
    Definition Classes
    GeneratedReads
  39. implicit def Tuple13R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)]
    Definition Classes
    GeneratedReads
  40. implicit def Tuple14R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)]
    Definition Classes
    GeneratedReads
  41. implicit def Tuple15R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)]
    Definition Classes
    GeneratedReads
  42. implicit def Tuple16R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)]
    Definition Classes
    GeneratedReads
  43. implicit def Tuple17R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)]
    Definition Classes
    GeneratedReads
  44. implicit def Tuple18R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)]
    Definition Classes
    GeneratedReads
  45. implicit def Tuple19R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18], arg18: Reads[T19]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)]
    Definition Classes
    GeneratedReads
  46. implicit def Tuple1R[T1](implicit arg0: Reads[T1]): Reads[(T1)]
    Definition Classes
    GeneratedReads
  47. implicit def Tuple20R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18], arg18: Reads[T19], arg19: Reads[T20]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)]
    Definition Classes
    GeneratedReads
  48. implicit def Tuple21R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18], arg18: Reads[T19], arg19: Reads[T20], arg20: Reads[T21]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)]
    Definition Classes
    GeneratedReads
  49. implicit def Tuple22R[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9], arg9: Reads[T10], arg10: Reads[T11], arg11: Reads[T12], arg12: Reads[T13], arg13: Reads[T14], arg14: Reads[T15], arg15: Reads[T16], arg16: Reads[T17], arg17: Reads[T18], arg18: Reads[T19], arg19: Reads[T20], arg20: Reads[T21], arg21: Reads[T22]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22)]
    Definition Classes
    GeneratedReads
  50. implicit def Tuple2R[T1, T2](implicit arg0: Reads[T1], arg1: Reads[T2]): Reads[(T1, T2)]
    Definition Classes
    GeneratedReads
  51. implicit def Tuple3R[T1, T2, T3](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3]): Reads[(T1, T2, T3)]
    Definition Classes
    GeneratedReads
  52. implicit def Tuple4R[T1, T2, T3, T4](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4]): Reads[(T1, T2, T3, T4)]
    Definition Classes
    GeneratedReads
  53. implicit def Tuple5R[T1, T2, T3, T4, T5](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5]): Reads[(T1, T2, T3, T4, T5)]
    Definition Classes
    GeneratedReads
  54. implicit def Tuple6R[T1, T2, T3, T4, T5, T6](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6]): Reads[(T1, T2, T3, T4, T5, T6)]
    Definition Classes
    GeneratedReads
  55. implicit def Tuple7R[T1, T2, T3, T4, T5, T6, T7](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7]): Reads[(T1, T2, T3, T4, T5, T6, T7)]
    Definition Classes
    GeneratedReads
  56. implicit def Tuple8R[T1, T2, T3, T4, T5, T6, T7, T8](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8)]
    Definition Classes
    GeneratedReads
  57. implicit def Tuple9R[T1, T2, T3, T4, T5, T6, T7, T8, T9](implicit arg0: Reads[T1], arg1: Reads[T2], arg2: Reads[T3], arg3: Reads[T4], arg4: Reads[T5], arg5: Reads[T6], arg6: Reads[T7], arg7: Reads[T8], arg8: Reads[T9]): Reads[(T1, T2, T3, T4, T5, T6, T7, T8, T9)]
    Definition Classes
    GeneratedReads
  58. implicit val ZoneIdReads: [ZoneId]

    Reads for the java.time.ZoneId type.

    Reads for the java.time.ZoneId type.

    Definition Classes
    EnvReads
  59. implicit def alternative(implicit a: [Reads]): [Reads]
  60. implicit def applicative(implicit applicativeJsResult: [JsResult]): [Reads]
  61. def apply[A](f: () => JsResult[A]): Reads[A]

    Returns an instance which uses f as Reads.reads function.

  62. def at[A](path: JsPath)(implicit reads: Reads[A]): Reads[A]
    Definition Classes
    PathReads
  63. implicit val bigDecReads: Reads[BigDecimal]

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads
  64. def charMapReads[V](implicit vr: Reads[V]): Reads[Map[Char, V]]

    Deserializer for a Map[Char, V]

    Deserializer for a Map[Char, V]

    Definition Classes
    DefaultReads
  65. val constraints: ConstraintReads
  66. def dateReads(pattern: String, corrector: (String) => String = identity): [Date]

    Reads for the java.util.Date type.

    Reads for the java.util.Date type.

    pattern

    a date pattern, as specified in java.text.SimpleDateFormat.

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks

    Definition Classes
    EnvReads
  67. def email(implicit reads: Reads[String]): Reads[String]
    Definition Classes
    ConstraintReads
  68. def enumNameReads[E <: Enumeration](enum: E): Reads[DefaultReads.enumNameReads.E.Value]

    Reads for scala.Enumeration types using the name.

    Reads for scala.Enumeration types using the name.

    enum

    a scala.Enumeration.

    Definition Classes
    DefaultReads
  69. def failed[A](msg: => String): Reads[A]

    Returns a JsError(cause) for any JSON value read.

    Returns a JsError(cause) for any JSON value read.

    import play.api.libs.json.Reads
    
    val r: Reads[String] = Reads.failed[String]("Failure message")
    See also

    pure

  70. def filter[A](otherwise: JsonValidationError)(p: (A) => Boolean)(implicit reads: Reads[A]): Reads[A]
    Definition Classes
    ConstraintReads
  71. def filterNot[A](error: JsonValidationError)(p: (A) => Boolean)(implicit reads: Reads[A]): Reads[A]
    Definition Classes
    ConstraintReads
  72. implicit def functorReads(implicit a: [Reads]): [Reads]
  73. def instantReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => [Instant]): [Instant]

    Reads for the java.time.Instant type.

    Reads for the java.time.Instant type.

    T

    Type of argument to instantiate date parser

    parsing

    Argument to instantiate date parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter
    
    import play.api.libs.json.Reads.instantReads
    
    val customReads1 = instantReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = instantReads(DateTimeFormatter.ISO_INSTANT)
    val customReads3 = instantReads(DateTimeFormatter.ISO_INSTANT, _.drop(1))
  74. implicit val javaBigDecReads: [BigDecimal]

    Deserializer for BigDecimal

    Deserializer for BigDecimal

    Definition Classes
    DefaultReads
  75. val javaDurationMillisReads: [Duration]

    Deserializer of Java Duration from a number of milliseconds.

    Deserializer of Java Duration from a number of milliseconds.

    Definition Classes
    EnvReads
  76. def javaDurationNumberReads(unit: TemporalUnit): [Duration]

    Deserializer of Java Duration from an integer (long) number, using the specified temporal unit.

    Deserializer of Java Duration from an integer (long) number, using the specified temporal unit.

    Definition Classes
    EnvReads
  77. val javaPeriodDaysReads: [Period]

    Deserializer of Java Period from a number (integer) of days.

    Deserializer of Java Period from a number (integer) of days.

    Definition Classes
    EnvReads
  78. val javaPeriodMonthsReads: [Period]

    Deserializer of Java Period from a number (integer) of months.

    Deserializer of Java Period from a number (integer) of months.

    Definition Classes
    EnvReads
  79. val javaPeriodWeeksReads: [Period]

    Deserializer of Java Period from a number (integer) of weeks.

    Deserializer of Java Period from a number (integer) of weeks.

    Definition Classes
    EnvReads
  80. val javaPeriodYearsReads: [Period]

    Deserializer of Java Period from a number (integer) of years.

    Deserializer of Java Period from a number (integer) of years.

    Definition Classes
    EnvReads
  81. def jsCopyTo[A <: JsValue](path: JsPath)(reads: Reads[A]): [JsObject]
    Definition Classes
    PathReads
  82. def jsPick[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): Reads[A]
    Definition Classes
    PathReads
  83. def jsPickBranch[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): [JsObject]
    Definition Classes
    PathReads
  84. def jsPrune(path: JsPath): [JsObject]
    Definition Classes
    PathReads
  85. def jsPut(path: JsPath, a: => JsValue): [JsObject]
    Definition Classes
    PathReads
  86. def jsUpdate[A <: JsValue](path: JsPath)(reads: Reads[A]): [JsObject]
    Definition Classes
    PathReads
  87. implicit def keyMapReads[K, V](implicit arg0: KeyReads[K], fmtv: Reads[V]): Reads[Map[K, V]]
    Definition Classes
    LowPriorityDefaultReads
  88. def list[A](implicit reads: Reads[A]): Reads[List[A]]
    Definition Classes
    ConstraintReads
  89. def localDateReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => [LocalDate]): [LocalDate]

    Reads for the java.time.LocalDate type.

    Reads for the java.time.LocalDate type.

    T

    Type of argument to instantiate date parser

    parsing

    Argument to instantiate date parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter
    
    import play.api.libs.json.Reads.localDateReads
    
    val customReads1 = localDateReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = localDateReads(DateTimeFormatter.ISO_DATE)
    val customReads3 = localDateReads(DateTimeFormatter.ISO_DATE, _.drop(1))
  90. def localDateTimeReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => [LocalDateTime]): [LocalDateTime]

    Reads for the java.time.LocalDateTime type.

    Reads for the java.time.LocalDateTime type.

    T

    Type of argument to instantiate date/time parser

    parsing

    Argument to instantiate date/time parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter
    
    import play.api.libs.json.Reads.localDateTimeReads
    
    val customReads1 = localDateTimeReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = localDateTimeReads(DateTimeFormatter.ISO_DATE_TIME)
    val customReads3 = localDateTimeReads(
      DateTimeFormatter.ISO_DATE_TIME, _.drop(1))
  91. def localTimeReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => [LocalTime]): [LocalTime]

    Reads for the java.time.LocalTime type.

    Reads for the java.time.LocalTime type.

    T

    Type of argument to instantiate time parser

    parsing

    Argument to instantiate time parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter
    
    import play.api.libs.json.Reads.localTimeReads
    
    val customReads1 = localTimeReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = localTimeReads(DateTimeFormatter.ISO_TIME)
    val customReads3 = localTimeReads(DateTimeFormatter.ISO_TIME, _.drop(1))
  92. val localeObjectReads: [Locale]

    Deserializer for a Locale from an object representation

    Deserializer for a Locale from an object representation

    Definition Classes
    EnvReads
  93. implicit val localeReads: [Locale]

    Deserializer for a Locale from a IETF BCP 47 string representation

    Deserializer for a Locale from a IETF BCP 47 string representation

    Definition Classes
    EnvReads
  94. def map[A](implicit reads: Reads[A]): Reads[Map[String, A]]
    Definition Classes
    ConstraintReads
  95. implicit def mapReads[V](implicit fmtv: Reads[V]): Reads[Map[String, V]]

    Deserializer for a Map[String,V]

    Deserializer for a Map[String,V]

    Definition Classes
    DefaultReads
  96. implicit def mapReads[K, V](k: (String) => JsResult[K])(implicit fmtv: Reads[V]): Reads[Map[K, V]]

    Deserializer for a Map[K,V]

    Deserializer for a Map[K,V]

    Definition Classes
    DefaultReads
  97. def max[O](m: O)(implicit reads: Reads[O], ord: Ordering[O]): Reads[O]

    Defines a maximum value for a Reads.

    Defines a maximum value for a Reads. Combine with min using andKeep, e.g. .read(Reads.min(0.1) andKeep Reads.max(1.0)).

    Definition Classes
    ConstraintReads
  98. def maxLength[M](m: Int)(implicit reads: Reads[M], p: (M) => Iterable[_]): Reads[M]
    Definition Classes
    ConstraintReads
  99. def min[O](m: O)(implicit reads: Reads[O], ord: Ordering[O]): Reads[O]

    Defines a minimum value for a Reads.

    Defines a minimum value for a Reads. Combine with max using andKeep, e.g. .read(Reads.min(0) andKeep Reads.max(100)).

    Definition Classes
    ConstraintReads
  100. def minLength[M](m: Int)(implicit reads: Reads[M], p: (M) => Iterable[_]): Reads[M]
    Definition Classes
    ConstraintReads
  101. def nullable[A](path: JsPath)(implicit reads: Reads[A]): Reads[Option[A]]

    Reads a Option[T] search optional or nullable field at JsPath (field not found or null is None and other cases are Error).

    Reads a Option[T] search optional or nullable field at JsPath (field not found or null is None and other cases are Error).

    It runs through JsValue following all JsPath nodes on JsValue: - If any node in JsPath is not found => returns None - If any node in JsPath is found with value "null" => returns None - If the entire path is found => applies implicit Reads[T]

    Definition Classes
    PathReads
  102. def nullableWithDefault[A](path: JsPath, defaultValue: => Option[A])(implicit reads: Reads[A]): Reads[Option[A]]

    Reads a Option[T] search nullable field at JsPath (null is None and other cases are Error).

    Reads a Option[T] search nullable field at JsPath (null is None and other cases are Error).

    It runs through JsValue following all JsPath nodes on JsValue: - If any node in JsPath is not found => returns default value - If the last node in JsPath is found with value "null" => returns None - If the entire path is found => applies implicit Reads[T]

    Definition Classes
    PathReads
  103. def of[A](implicit r: Reads[A]): Reads[A]

    The simpler of all Reads that just finds an implicit Reads[A] of the expected type

    The simpler of all Reads that just finds an implicit Reads[A] of the expected type

    Definition Classes
    ConstraintReads
    Annotations
    @inline()
  104. def offsetDateTimeReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => [OffsetDateTime]): [OffsetDateTime]

    Reads for the java.time.OffsetDateTime type.

    Reads for the java.time.OffsetDateTime type.

    Note: it is intentionally not supported to read an OffsetDateTime from a number.

    T

    the type of argument to instantiate date/time parser

    parsing

    The argument to instantiate date/time parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks. Function identity can be passed if no correction is needed.

    p

    the implicit conversion based on parsing

    Definition Classes
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter
    
    import play.api.libs.json.Reads.offsetDateTimeReads
    
    val customReads1 = offsetDateTimeReads("dd/MM/yyyy, HH:mm:ss (Z)")
    val customReads2 = offsetDateTimeReads(DateTimeFormatter.ISO_OFFSET_DATE_TIME)
    val customReads3 = offsetDateTimeReads(
      DateTimeFormatter.ISO_OFFSET_DATE_TIME, _.drop(1))
  105. def optionNoError[A](implicit reads: Reads[A]): Reads[Option[A]]

    Stupidly reads a field as an Option mapping any error (format or missing field) to None

    Stupidly reads a field as an Option mapping any error (format or missing field) to None

    Definition Classes
    ConstraintReads
  106. def optionWithNull[T](implicit rds: Reads[T]): Reads[Option[T]]

    very simple optional field Reads that maps "null" to None

    very simple optional field Reads that maps "null" to None

    Definition Classes
    ConstraintReads
  107. val path: PathReads
  108. def pattern(regex: => Regex, error: String = "error.pattern")(implicit reads: Reads[String]): Reads[String]

    Defines a regular expression constraint for String values, i.e.

    Defines a regular expression constraint for String values, i.e. the string must match the regular expression pattern

    Definition Classes
    ConstraintReads
  109. def pure[A](f: => A): Reads[A]

    Returns a JsSuccess(a) (with root path) for any JSON value read.

    Returns a JsSuccess(a) (with root path) for any JSON value read.

    import play.api.libs.json.Reads
    
    val r: Reads[String] = Reads.pure("foo")
    Definition Classes
    ConstraintReads
    See also

    failed

  110. def required(path: JsPath)(implicit reads: [JsValue]): [JsValue]
    Definition Classes
    PathReads
  111. def seq[A](implicit reads: Reads[A]): Reads[Seq[A]]
    Definition Classes
    ConstraintReads
  112. def set[A](implicit reads: Reads[A]): Reads[Set[A]]
    Definition Classes
    ConstraintReads
  113. def sqlDateReads(pattern: String, corrector: (String) => String = identity): [Date]

    Reads for the java.sql.Date type.

    Reads for the java.sql.Date type.

    pattern

    a date pattern, as specified in java.text.SimpleDateFormat.

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks

    Definition Classes
    EnvReads
  114. implicit def traversableReads[F[_], A](implicit bf: Factory[A, F[A]], ra: Reads[A]): Reads[F[A]]

    Generic deserializer for collections types.

    Generic deserializer for collections types.

    Definition Classes
    LowPriorityDefaultReads
  115. def tuple2[A, B](name1: String, name2: String)(implicit arg0: Reads[A], arg1: Reads[B]): Reads[(A, B)]

    Reads a JSON object and constructs a tuple of two values, with custom names for the element fields.

    Reads a JSON object and constructs a tuple of two values, with custom names for the element fields.

    A

    the type for the first element

    B

    the type for the second element

    val tuple2Reads: Reads[(String, Int)] = Reads.tuple2[String, Int]("name", "age")
    
    val tuple2ExampleJson = Json.obj("name" -> "Alice", "age" -> 25)
    val tuple2Result: JsResult[(String, Int)] = tuple2Reads.reads(tuple2ExampleJson)
    // JsSuccess(("Alice", 25))
    name1

    the name of the first element _1

    name2

    the name of the second element _2

    Definition Classes
    DefaultReads
  116. def tuple3[A, B, C](name1: String, name2: String, name3: String)(implicit arg0: Reads[A], arg1: Reads[B], arg2: Reads[C]): Reads[(A, B, C)]

    Reads a JSON object and constructs a tuple of three values, with custom names for the element fields.

    Reads a JSON object and constructs a tuple of three values, with custom names for the element fields.

    A

    the type for the first element

    B

    the type for the second element

    C

    the type for the third element

    val tuple3Reads: Reads[(String, Int, Boolean)] =
      Reads.tuple3[String, Int, Boolean]("name", "age", "isStudent")
    
    val tuple3ExampleJson: JsValue =
      Json.obj("name" -> "Alice", "age" -> 25, "isStudent" -> true)
    
    val tuple3Result: JsResult[(String, Int, Boolean)] =
      tuple3Reads.reads(tuple3ExampleJson)
    // JsSuccess(("Alice", 25, true))
    name1

    the name of the first element _1

    name2

    the name of the second element _2

    name3

    the name of the third element _3

    Definition Classes
    DefaultReads
  117. def tuple4[A, B, C, D](name1: String, name2: String, name3: String, name4: String)(implicit arg0: Reads[A], arg1: Reads[B], arg2: Reads[C], arg3: Reads[D]): Reads[(A, B, C, D)]

    Reads a JSON object and constructs a tuple of four values, with custom names for the element fields.

    Reads a JSON object and constructs a tuple of four values, with custom names for the element fields.

    A

    the type for the first element

    B

    the type for the second element

    C

    the type for the third element

    D

    the type for the fourth element

    val tuple4Reads: Reads[(String, Int, Boolean, Double)] =
      Reads.tuple4[String, Int, Boolean, Double](
        "name", "age", "isStudent", "score")
    
    val tuple4ExampleJson: JsValue = Json.obj(
      "name" -> "Alice", "age" -> 25, "isStudent" -> true, "score" -> 78.9)
    
    val tuple4Result: JsResult[(String, Int, Boolean, Double)] =
      tuple4Reads.reads(tuple4ExampleJson)
      // JsSuccess(("Alice", 25, true, 78.9))
    name1

    the name of the first element _1

    name2

    the name of the second element _2

    name3

    the name of the third element _3

    name4

    the name of the fourth element _4

    Definition Classes
    DefaultReads
  118. implicit val uriReads: [URI]

    Deserializer for java.net.URI

    Deserializer for java.net.URI

    Definition Classes
    DefaultReads
  119. implicit val uuidReads: [UUID]
    Definition Classes
    DefaultReads
  120. def verifying[A](cond: (A) => Boolean)(implicit rds: Reads[A]): Reads[A]
    Definition Classes
    ConstraintReads
  121. def verifyingIf[A](cond: (A) => Boolean)(subreads: Reads[_])(implicit rds: Reads[A]): Reads[A]
    Definition Classes
    ConstraintReads
  122. def withDefault[A](path: JsPath, defaultValue: => A)(implicit reads: Reads[A]): Reads[A]
    Definition Classes
    PathReads
  123. def zonedDateTimeReads[T](parsing: T, corrector: (String) => String = identity)(implicit p: (T) => [ZonedDateTime]): [ZonedDateTime]

    Reads for the java.time.ZonedDateTime type.

    Reads for the java.time.ZonedDateTime type.

    T

    Type of argument to instantiate date/time parser

    parsing

    Argument to instantiate date/time parser. Actually either a pattern (string) or a formatter (java.time.format.DateTimeFormatter)

    corrector

    a simple string transformation function that can be used to transform input String before parsing. Useful when standards are not exactly respected and require a few tweaks. Function identity can be passed if no correction is needed.

    p

    Typeclass instance based on parsing

    Definition Classes
    EnvReads
    See also

    DefaultWrites.TemporalFormatter

    import java.time.format.DateTimeFormatter
    
    import play.api.libs.json.Reads.zonedDateTimeReads
    
    val customReads1 = zonedDateTimeReads("dd/MM/yyyy, HH:mm:ss")
    val customReads2 = zonedDateTimeReads(DateTimeFormatter.ISO_DATE_TIME)
    val customReads3 = zonedDateTimeReads(
      DateTimeFormatter.ISO_DATE_TIME, _.drop(1))
  124. implicit object JsArrayMonoid extends [JsArray]
  125. implicit object JsObjectMonoid extends [JsObject]