argonaut/argonaut/HCursor

HCursor

case class HCursor(cursor: Cursor, history: CursorHistory)
Companion:
object
Source:
HCursor.scala
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def --(q: JsonField): ACursor

Move the cursor to the given sibling field in a JSON object (alias for field).

Move the cursor to the given sibling field in a JSON object (alias for field).

Source:
HCursor.scala
def --\(q: JsonField): ACursor

Move the cursor down to a JSON object at the given field (alias for downField).

Move the cursor down to a JSON object at the given field (alias for downField).

Source:
HCursor.scala
def -<-:(n: Int): ACursor

Move the cursor left in a JSON array the given number of times. A negative value will move the cursor right (alias for leftN).

Move the cursor left in a JSON array the given number of times. A negative value will move the cursor right (alias for leftN).

Source:
HCursor.scala
def -\(p: Json => Boolean): ACursor

Move the cursor down to a JSON array at the first element satisfying the given predicate (alias for downAt).

Move the cursor down to a JSON array at the first element satisfying the given predicate (alias for downAt).

Source:
HCursor.scala
def :->-(n: Int): ACursor

Move the cursor right in a JSON array the given number of times. A negative value will move the cursor left (alias for rightN).

Move the cursor right in a JSON array the given number of times. A negative value will move the cursor left (alias for rightN).

Source:
HCursor.scala
def :->?(p: Json => Boolean): ACursor

Move the cursor right in a JSON array until the given predicate matches the focus (alias for rightAt).

Move the cursor right in a JSON array until the given predicate matches the focus (alias for rightAt).

Source:
HCursor.scala
def :=(j: Json): HCursor

Set the focus to the given value (alias for set).

Set the focus to the given value (alias for set).

Source:
HCursor.scala
def =\(n: Int): ACursor

Move the cursor down to a JSON array at the given index (alias for downN).

Move the cursor down to a JSON array at the given index (alias for downN).

Source:
HCursor.scala
def >->(k: Json => Json): HCursor

Update the focus with the given function (alias for withFocus).

Update the focus with the given function (alias for withFocus).

Source:
HCursor.scala
def ?<-:(p: Json => Boolean): ACursor

Move the cursor left in a JSON array until the given predicate matches the focus (alias for leftAt).

Move the cursor left in a JSON array until the given predicate matches the focus (alias for leftAt).

Source:
HCursor.scala
def \\: ACursor

Move the cursor down to a JSON array at the first element (alias for downArray).

Move the cursor down to a JSON array at the first element (alias for downArray).

Source:
HCursor.scala
def as[A](implicit e: DecodeJson[A]): DecodeResult[A]

Attempts to decode this cursor focus value to another data type. Alias for jdecode.

Attempts to decode this cursor focus value to another data type. Alias for jdecode.

Source:
HCursor.scala
def delete: ACursor

Deletes the JSON value at focus and moves up to parent (alias for deleteGoParent).

Deletes the JSON value at focus and moves up to parent (alias for deleteGoParent).

Source:
HCursor.scala
def deleteGoField(q: JsonField): ACursor

Deletes the JSON value at focus and moves to the given sibling field in a JSON object.

Deletes the JSON value at focus and moves to the given sibling field in a JSON object.

Source:
HCursor.scala
def deleteGoFirst: ACursor

Deletes the JSON value at focus and moves to the first in a JSON array.

Deletes the JSON value at focus and moves to the first in a JSON array.

Source:
HCursor.scala
def deleteGoLast: ACursor

Deletes the JSON value at focus and moves to the last in a JSON array.

Deletes the JSON value at focus and moves to the last in a JSON array.

Source:
HCursor.scala
def deleteGoLeft: ACursor

Deletes the JSON value at focus and moves to the left in a JSON array.

Deletes the JSON value at focus and moves to the left in a JSON array.

Source:
HCursor.scala
def deleteGoParent: ACursor

Deletes the JSON value at focus and moves up to parent (alias for unary_!).

Deletes the JSON value at focus and moves up to parent (alias for unary_!).

Source:
HCursor.scala
def deleteGoRight: ACursor

Deletes the JSON value at focus and moves to the right in a JSON array.

Deletes the JSON value at focus and moves to the right in a JSON array.

Source:
HCursor.scala
def deleteLefts: ACursor

Deletes all JSON values to left of focus in a JSON array.

Deletes all JSON values to left of focus in a JSON array.

Source:
HCursor.scala
def deleteRights: ACursor

Deletes all JSON values to right of focus in a JSON array.

Deletes all JSON values to right of focus in a JSON array.

Source:
HCursor.scala
def downArray: ACursor

Move the cursor down to a JSON array at the first element (alias for \\).

Move the cursor down to a JSON array at the first element (alias for \\).

Source:
HCursor.scala
def downAt(p: Json => Boolean): ACursor

Move the cursor down to a JSON array at the first element satisfying the given predicate (alias for -\).

Move the cursor down to a JSON array at the first element satisfying the given predicate (alias for -\).

Source:
HCursor.scala
def downField(q: JsonField): ACursor

Move the cursor down to a JSON object at the given field (alias for --\).

Move the cursor down to a JSON object at the given field (alias for --\).

Source:
HCursor.scala
def downN(n: Int): ACursor

Move the cursor down to a JSON array at the given index (alias for =\).

Move the cursor down to a JSON array at the given index (alias for =\).

Source:
HCursor.scala
def field(q: JsonField): ACursor

Move the cursor to the given sibling field in a JSON object (alias for --).

Move the cursor to the given sibling field in a JSON object (alias for --).

Source:
HCursor.scala
def fieldSet: Option[Set[JsonField]]

All field names in a JSON object.

All field names in a JSON object.

Source:
HCursor.scala
def fields: Option[List[JsonField]]

All field names in a JSON object.

All field names in a JSON object.

Source:
HCursor.scala
def find(p: Json => Boolean): ACursor

Find the first element at or to the right of focus in a JSON array where the given predicate matches the focus.

Find the first element at or to the right of focus in a JSON array where the given predicate matches the focus.

Source:
HCursor.scala
def first: ACursor

Move the cursor to the first in a JSON array.

Move the cursor to the first in a JSON array.

Source:
HCursor.scala
def focus: Json

Return the current focus.

Return the current focus.

Source:
HCursor.scala
def get[A](name: String)(implicit e: DecodeJson[A]): DecodeResult[A]

Attempts to move down onto a field name and decode the focus.

Attempts to move down onto a field name and decode the focus.

Source:
HCursor.scala
def jdecode[A](implicit e: DecodeJson[A]): DecodeResult[A]

Attempts to decode this cursor focus value to another data type.

Attempts to decode this cursor focus value to another data type.

Source:
HCursor.scala
def last: ACursor

Move the cursor to the last in a JSON array.

Move the cursor to the last in a JSON array.

Source:
HCursor.scala
def left: ACursor

Move the cursor left in a JSON array.

Move the cursor left in a JSON array.

Source:
HCursor.scala
def leftAt(p: Json => Boolean): ACursor

Move the cursor left in a JSON array until the given predicate matches the focus (alias for ?<-:).

Move the cursor left in a JSON array until the given predicate matches the focus (alias for ?<-:).

Source:
HCursor.scala
def leftN(n: Int): ACursor

Move the cursor left in a JSON array the given number of times. A negative value will move the cursor right (alias for -<-:).

Move the cursor left in a JSON array the given number of times. A negative value will move the cursor right (alias for -<-:).

Source:
HCursor.scala
def lefts: Option[JsonArray]

Return the values left of focus in a JSON array.

Return the values left of focus in a JSON array.

Source:
HCursor.scala
def right: ACursor

Move the cursor right in a JSON array.

Move the cursor right in a JSON array.

Source:
HCursor.scala
def rightAt(p: Json => Boolean): ACursor

Move the cursor right in a JSON array until the given predicate matches the focus (alias for :->?).

Move the cursor right in a JSON array until the given predicate matches the focus (alias for :->?).

Source:
HCursor.scala
def rightN(n: Int): ACursor

Move the cursor right in a JSON array the given number of times. A negative value will move the cursor left (alias for :->-).

Move the cursor right in a JSON array the given number of times. A negative value will move the cursor left (alias for :->-).

Source:
HCursor.scala
def rights: Option[JsonArray]

Return the values right of focus in a JSON array.

Return the values right of focus in a JSON array.

Source:
HCursor.scala
def set(j: Json): HCursor

Set the focus to the given value (alias for :=).

Set the focus to the given value (alias for :=).

Source:
HCursor.scala
def setLefts(x: List[Json]): ACursor

Set the values to the left of focus in a JSON array.

Set the values to the left of focus in a JSON array.

Source:
HCursor.scala
def setRights(x: List[Json]): ACursor

Set the values to the right of focus in a JSON array.

Set the values to the right of focus in a JSON array.

Source:
HCursor.scala
def unary_!: ACursor

Deletes the JSON value at focus and moves up to parent (alias for deleteGoParent).

Deletes the JSON value at focus and moves up to parent (alias for deleteGoParent).

Source:
HCursor.scala
def unary_-: Json

Unapplies the cursor to the top-level parent (alias for undo).

Unapplies the cursor to the top-level parent (alias for undo).

Source:
HCursor.scala
def undo: Json

Unapplies the cursor to the top-level parent (alias for unary_-).

Unapplies the cursor to the top-level parent (alias for unary_-).

Source:
HCursor.scala
def up: ACursor

Move the cursor up one step to the parent context.

Move the cursor up one step to the parent context.

Source:
HCursor.scala
def withFocus(k: Json => Json): HCursor

Update the focus with the given function (alias for >->).

Update the focus with the given function (alias for >->).

Source:
HCursor.scala

Inherited methods

def productIterator: Iterator[Any]
Inherited from:
Product