t

play.api.libs.json

PathReads

trait PathReads extends AnyRef

Source
JsConstraints.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Reads
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PathReads
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def at[A](path: JsPath)(implicit reads: Reads[A]): Reads[A]
  2. def jsCopyTo[A <: JsValue](path: JsPath)(reads: Reads[A]): [JsObject]
  3. def jsPick[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): Reads[A]
  4. def jsPickBranch[A <: JsValue](path: JsPath)(implicit reads: Reads[A]): [JsObject]
  5. def jsPrune(path: JsPath): [JsObject]
  6. def jsPut(path: JsPath, a: => JsValue): [JsObject]
  7. def jsUpdate[A <: JsValue](path: JsPath)(reads: Reads[A]): [JsObject]
  8. 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]

  9. 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]

  10. def required(path: JsPath)(implicit reads: [JsValue]): [JsValue]
  11. def withDefault[A](path: JsPath, defaultValue: => A)(implicit reads: Reads[A]): Reads[A]