Type Members

1.  trait CfgError extends AnyRef

   Marker trait for all errors that can arise during config loading or decoding.

2.  sealed trait INode[+I <: Id] extends AnyRef

   A node in the config tree, tagged with its path type I.

   A node in the config tree, tagged with its path type I.

   Every node in the tree is an INode. Use the type alias Node when the path type does not matter. Concrete variants (all in the Node companion):

   • Node.INone — key was looked up but not found; also a NodeError
   • Node.INull — explicit null value in the source; also a NodeError
   • Node.IScalar — a leaf string value
   • Node.IMap / Node.ISeq — container nodes (map and sequence)

   I

   the Id subtype that describes this node's position in the tree

3.  sealed trait Id extends AnyRef

   A path addressing a position in the config tree.

   A path addressing a position in the config tree.

   Every Node carries an Id that identifies where in the tree it lives. The path method renders the full address as a human-readable string using dotted-key notation with bracket-indexed sequences, e.g. server.hosts[0].

   Concrete implementations:

   • Id.Root — the top of the tree; path is the empty string
   • Id.Key — a named field inside a map node
   • Id.Index — a positional element inside a sequence node
4.  trait Location extends AnyRef

   Source location of a config value (file name, line number, etc.).

   Source location of a config value (file name, line number, etc.).

   The format of description is determined by the backend that produced the node.

5.  type Node = INode[Id]

   Type alias for INode with an unspecified path type, used throughout the API when the concrete Id subtype does not matter.

6.  trait NodeError extends CfgError

   A CfgError tied to a specific Node.

   A CfgError tied to a specific Node.

   When processing a node produces an error, the error should carry that node so callers can report exactly where in the tree the problem occurred. Node.INone and Node.INull implement this trait directly, since the nodes themselves represent erroneous states.