play-json
API
Generated with
play-json/play.api.libs.json/PathReads

PathReads

play.api.libs.json.PathReads
trait PathReads

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Reads.type

Members list

Value members

Concrete methods

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

Attributes

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]

Attributes

def required(path: JsPath)(implicit reads: Reads[JsValue]): Reads[JsValue]
def withDefault[A](path: JsPath, defaultValue: => A)(implicit reads: Reads[A]): Reads[A]
Generated with