Default deserializer type classes.
Attributes
- Companion
- trait
- Graph
-
- Supertypes
-
trait GeneratedReadstrait DefaultReadstrait LowPriorityDefaultReadstrait EnvReadstrait PathReadstrait ConstraintReadsclass Objecttrait Matchableclass AnyShow all
- Self type
-
Reads.type
Members list
Type members
Classlikes
Attributes
- Supertypes
- Self type
-
JsArrayMonoid.type
Attributes
- Supertypes
- Self type
-
JsObjectMonoid.type
Inherited classlikes
Deserializer for BigInt
Deserializer for BigInteger
Deserializer for Boolean types.
Deserializer for Byte types.
Deserializer for Double types.
Deserializer for Float types.
Deserializer for Int types.
Deserializer for JsArray.
Deserializer for JsBoolean.
Deserializer for JsNumber.
Deserializer for JsObject.
Deserializer for JsString.
Deserializer for JsValue.
Deserializer for Long types.
Deserializer for Short types.
Deserializer for String types.
Deserializer for java.util.UUID
Value members
Concrete methods
Returns an instance which uses f
as Reads.reads function.
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")
Attributes
- See also
-
pure
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")
Attributes
- See also
- Definition Classes
Inherited methods
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) }
Attributes
- Inherited from:
- DefaultReads
Deserializer for a Map[Char, V]
Attributes
- Inherited from:
- ConstraintReads
Reads for scala.Enumeration
types using the name.
Reads for scala.Enumeration
types using the name.
Value parameters
- enum
-
a
scala.Enumeration
.
Attributes
- Inherited from:
- DefaultReads
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- PathReads
Attributes
- Inherited from:
- PathReads
Attributes
- Inherited from:
- PathReads
Attributes
- Inherited from:
- PathReads
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- ConstraintReads
Defines a maximum value for a Reads. Combine with min
using andKeep
, e.g. .read(Reads.min(0.1) andKeep Reads.max(1.0))
.
Defines a maximum value for a Reads. Combine with min
using andKeep
, e.g. .read(Reads.min(0.1) andKeep Reads.max(1.0))
.
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- ConstraintReads
Defines a minimum value for a Reads. Combine with max
using andKeep
, e.g. .read(Reads.min(0) andKeep Reads.max(100))
.
Defines a minimum value for a Reads. Combine with max
using andKeep
, e.g. .read(Reads.min(0) andKeep Reads.max(100))
.
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- ConstraintReads
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]
Attributes
- Inherited from:
- PathReads
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]
Attributes
- Inherited from:
- PathReads
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
Attributes
- Inherited from:
- ConstraintReads
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
Attributes
- Inherited from:
- ConstraintReads
very simple optional field Reads that maps "null" to None
very simple optional field Reads that maps "null" to None
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- EnvReads
Attributes
- Inherited from:
- EnvReads
Defines a regular expression constraint for String
values, i.e. the string must match the regular expression pattern
Defines a regular expression constraint for String
values, i.e. the string must match the regular expression pattern
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- PathReads
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- ConstraintReads
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.
Type parameters
- 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))
Value parameters
- name1
-
the name of the first element
_1
- name2
-
the name of the second element
_2
Attributes
- Inherited from:
- DefaultReads
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.
Type parameters
- 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))
Value parameters
- name1
-
the name of the first element
_1
- name2
-
the name of the second element
_2
- name3
-
the name of the third element
_3
Attributes
- Inherited from:
- DefaultReads
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.
Type parameters
- 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))
Value parameters
- 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
Attributes
- Inherited from:
- DefaultReads
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- ConstraintReads
Attributes
- Inherited from:
- PathReads
Implicits
Implicits
Inherited implicits
Deserializer for Array[T] types.
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Attributes
- Inherited from:
- GeneratedReads
Deserializer for BigDecimal
Deserializer for BigDecimal
Attributes
- Inherited from:
- LowPriorityDefaultReads
Deserializer for a Map[String,V]
Deserializer for a Map[K,V]
Generic deserializer for collections types.
Deserializer for java.net.URI
Attributes
- Inherited from:
- DefaultReads