HCursor

cats.xml.cursor.HCursor
trait HCursor[HFocus <: Xml, +VC <: VCursor[_, VC], +HC <: HCursor[_, _, HC]] extends Cursor[HFocus]

Attributes

Graph
Supertypes
trait Cursor[HFocus]
trait Serializable
class Object
trait Matchable
class Any
Known subtypes

Members list

Concise view

Type members

Types

override type Focus = HFocus

Value members

Abstract methods

def head: HC
def last: HC
def left: HC
def right: HC

Concrete methods

final def up: VC

Inherited methods

def as[T : Decoder]: FreeCursor[Xml, T]

Create a FreeCursor which represent a cursor with a free T type as result of the focusing, this implies that a Decoder instance is need to convert the fixed Xml type of the Cursor to the free T type of the FreeCursor.

Create a FreeCursor which represent a cursor with a free T type as result of the focusing, this implies that a Decoder instance is need to convert the fixed Xml type of the Cursor to the free T type of the FreeCursor.

So, practically speaking, when the FreeCursor is applied this Cursor is applied and the result is decoded using the specified Decoder for type T.

Attributes

T

free type in which decode the current cursor result

Returns:

A new FreeCursor

Inherited from:
Cursor
def focus(input: XmlNode): Result[X]

Apply the current cursor to the specified input. This allows to select a precise part of the Xml tree.

Apply the current cursor to the specified input. This allows to select a precise part of the Xml tree.

The method is pure and return a Left when the focusing fails

Attributes

input

target of the cursor

Returns:

Right when succeed Left when fail

Inherited from:
Cursor
def path: String

A String representation of the cursor.

A String representation of the cursor.

Attributes

Returns:

a String which represent the cursor path

Inherited from:
Cursor
final override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns:

a string representation of the object.

Definition Classes
Cursor -> Any
Inherited from:
Cursor

Abstract fields

protected val vCursor: VC