pureconfig-core
API
Generated with
pureconfig-core/pureconfig/ConfigListCursor

ConfigListCursor

pureconfig.ConfigListCursor
case class ConfigListCursor(listValue: ConfigList, pathElems: List[String], offset: Int) extends ConfigCursor

A ConfigCursor pointing to a config list.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait ConfigCursor
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def asConfigValue: Result[ConfigList]

Casts this cursor to a ConfigValue.

Casts this cursor to a ConfigValue.

Attributes

Returns

a Right with the config value pointed to by this cursor if the value is defined, Left with a list of failures otherwise.

Definition Classes
override def asListCursor: Result[ConfigListCursor]

Casts this cursor to a ConfigListCursor.

Casts this cursor to a ConfigListCursor.

Attributes

Returns

a Right with this cursor as a list cursor if the cast can be done, Left with a list of failures otherwise.

Definition Classes
def atIndex(idx: Int): Result[ConfigCursor]

Returns a cursor to the config at a given index.

Returns a cursor to the config at a given index.

Value parameters

idx

the index of the config for which a cursor should be returned

Attributes

Returns

a Right with a cursor to the config at idx if such a config exists, a Left with a list of failures otherwise.

def atIndexOrUndefined(idx: Int): ConfigCursor

Returns a cursor to the config at a given index. An out of range index will return a cursor to an undefined value.

Returns a cursor to the config at a given index. An out of range index will return a cursor to an undefined value.

Value parameters

idx

the index of the config for which a cursor should be returned

Attributes

Returns

a cursor to the config at idx if such a config exists, a cursor to an undefined value otherwise.

def isEmpty: Boolean

Returns whether the config list pointed to by this cursor is empty.

Returns whether the config list pointed to by this cursor is empty.

Attributes

def list: List[ConfigCursor]

Returns a list of cursors to the elements of the config list pointed to by this cursor.

Returns a list of cursors to the elements of the config list pointed to by this cursor.

Attributes

Returns

a list of cursors to the elements of the config list pointed to by this cursor.

def size: Int

Returns the size of the config list pointed to by this cursor.

Returns the size of the config list pointed to by this cursor.

Attributes

def tailOption: Option[ConfigListCursor]

Returns a cursor to the tail of the config list pointed to by this cursor if non-empty.

Returns a cursor to the tail of the config list pointed to by this cursor if non-empty.

Attributes

Returns

a Some with the tail of the config list if the list is not empty, None otherwise.

def valueOpt: Option[ConfigList]

The optional ConfigValue which this cursor points to.

The optional ConfigValue which this cursor points to.

Attributes

Inherited methods

def asBoolean: Result[Boolean]

Casts this cursor to a boolean.

Casts this cursor to a boolean.

Attributes

Returns

a Right with the boolean value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asByte: Result[Byte]

Casts this cursor to a byte.

Casts this cursor to a byte.

Attributes

Returns

a Right with the byte value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asDouble: Result[Double]

Casts this cursor to a double.

Casts this cursor to a double.

Attributes

Returns

a Right with the double value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asFloat: Result[Float]

Casts this cursor to a float.

Casts this cursor to a float.

Attributes

Returns

a Right with the float value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asInt: Result[Int]

Casts this cursor to an int.

Casts this cursor to an int.

Attributes

Returns

a Right with the int value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asList: Result[List[ConfigCursor]]

Casts this cursor to a list of cursors.

Casts this cursor to a list of cursors.

Attributes

Returns

a Right with the list pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asLong: Result[Long]

Casts this cursor to a long.

Casts this cursor to a long.

Attributes

Returns

a Right with the long value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asMap: Result[Map[String, ConfigCursor]]

Casts this cursor to a map from config keys to cursors.

Casts this cursor to a map from config keys to cursors.

Attributes

Returns

a Right with the map pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asObjectCursor: Result[ConfigObjectCursor]

Casts this cursor to a ConfigObjectCursor.

Casts this cursor to a ConfigObjectCursor.

Attributes

Returns

a Right with this cursor as an object cursor if it points to an object, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asShort: Result[Short]

Casts this cursor to a short.

Casts this cursor to a short.

Attributes

Returns

a Right with the short value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def asString: Result[String]

Casts this cursor to a string.

Casts this cursor to a string.

Attributes

Returns

a Right with the string value pointed to by this cursor if the cast can be done, Left with a list of failures otherwise.

Inherited from:
ConfigCursor
def failed[A](reason: FailureReason): Result[A]

Returns a failed ConfigReader result resulting from scoping a FailureReason into the context of this cursor.

Returns a failed ConfigReader result resulting from scoping a FailureReason into the context of this cursor.

This operation is the easiest way to return a failure from a ConfigReader.

Type parameters

A

the returning type of the ConfigReader

Value parameters

reason

the reason of the failure

Attributes

Returns

a failed ConfigReader result built by scoping reason into the context of this cursor.

Inherited from:
ConfigCursor
def failureFor(reason: FailureReason): ConfigReaderFailure

Returns a ConfigReaderFailure resulting from scoping a FailureReason into the context of this cursor.

Returns a ConfigReaderFailure resulting from scoping a FailureReason into the context of this cursor.

This operation is useful for constructing ConfigReaderFailures when there are multiple FailureReasons.

Value parameters

reason

the reason of the failure

Attributes

Returns

a ConfigReaderFailure built by scoping reason into the context of this cursor.

Inherited from:
ConfigCursor
def fluent: FluentConfigCursor

Attributes

Inherited from:
ConfigCursor
def isNull: Boolean

Returns whether this cursor points to a null config value. An explicit null value is different than a missing value - isUndefined can be used to check for the latter.

Returns whether this cursor points to a null config value. An explicit null value is different than a missing value - isUndefined can be used to check for the latter.

Attributes

Returns

true if this cursor points to a null value, false otherwise.

Inherited from:
ConfigCursor
def isUndefined: Boolean

Returns whether this cursor points to an undefined value. A cursor can point to an undefined value when a missing config key is requested or when a null ConfigValue is provided, among other reasons.

Returns whether this cursor points to an undefined value. A cursor can point to an undefined value when a missing config key is requested or when a null ConfigValue is provided, among other reasons.

Attributes

Returns

true if this cursor points to an undefined value, false otherwise.

Inherited from:
ConfigCursor
def origin: Option[ConfigOrigin]

The file system location of the config to which this cursor points.

The file system location of the config to which this cursor points.

Attributes

Inherited from:
ConfigCursor
def path: String

The path in the config to which this cursor points.

The path in the config to which this cursor points.

Attributes

Inherited from:
ConfigCursor
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def scopeFailure[A](result: Either[FailureReason, A]): Result[A]

Returns a failed ConfigReader result resulting from scoping a Either[FailureReason, A] into the context of this cursor.

Returns a failed ConfigReader result resulting from scoping a Either[FailureReason, A] into the context of this cursor.

This operation is needed when control of the reading process is passed to a place without a ConfigCursor instance providing the nexessary context (for example, when ConfigReader.fromString is used. In those scenarios, the call should be wrapped in this method in order to turn FailureReason instances into ConfigReaderFailures.

Type parameters

A

the returning type of the ConfigReader

Value parameters

result

the result of a config reading operation

Attributes

Returns

a ConfigReader result built by scoping reason into the context of this cursor.

Inherited from:
ConfigCursor
Generated with