Struct PathLeaf 

pub struct PathLeaf<V> { /* private fields */ }

A leaf value addressed by a parsed path.

FromStr for PathLeaf<String> splits key.path=value, parses the LHS as a RefPath, and stores the RHS as-is. The serde_json::Value impl parses that RHS as JSON, falling back to a string: port=8080 is a number, name=foo is a string.

The grammar accepts bracket steps — a[0]=1 parses — because it is the one spelling references also use. Whether such a path may write is RefPath::try_into_keys’ question, asked at conversion time.

Display of a typed leaf is canonical — path, =, compact JSON of the leaf — so name=foo displays as name="foo". FromStr ∘ Display preserves path and leaf, not the original spelling. PathLeaf<String> displays the raw RHS.

Implementations

impl<V> PathLeaf<V>

pub fn new(path: Vec<String>, leaf: V) -> Result<Self, PathError>

Build from path segments and a leaf. Rejects an empty path or any empty segment.

pub fn path(&self) -> &[Seg]

The path as steps. May hold Index steps from the grammar — consumers that write run try_into_keys.

pub fn leaf(&self) -> &V

The RHS value, not yet wrapped in nested objects.

pub fn map_leaf<T>(self, f: impl FnOnce(V) -> T) -> PathLeaf<T>

Replace the leaf, keeping the path. The path is already valid, so this cannot fail the way new can.

pub fn try_map_leaf<T, E>( self, f: impl FnOnce(V) -> Result<T, E>, ) -> Result<PathLeaf<T>, E>

map_leaf when the conversion can fail.

impl PathLeaf<String>

pub fn validate_keys(&self) -> Result<(), PathError>

Validate this writer’s path before reading inputs or selecting a format.

pub fn into_layer<V: ConfigFormat>(self) -> Result<V, PathError>

Type the RHS in the native format and expand it into a nested object.

Trait Implementations

impl<V: Clone> Clone for PathLeaf<V>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<V: Debug> Debug for PathLeaf<V>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for PathLeaf<String>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for PathLeaf<Value>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<PathLeaf<String>> for PathLeaf<Value>

fn from(path_leaf: PathLeaf<String>) -> Self

Converts to this type from the input type.

impl FromStr for PathLeaf<String>

type Err = PathError

The associated error which can be returned from parsing.

fn from_str(expr: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl FromStr for PathLeaf<Value>

type Err = PathError

The associated error which can be returned from parsing.

fn from_str(expr: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<V: PartialEq> PartialEq for PathLeaf<V>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<V: PartialEq> StructuralPartialEq for PathLeaf<V>

impl TryFrom<PathLeaf<Value>> for Value

fn try_from(path_leaf: PathLeaf<Value>) -> Result<Self, Self::Error>

Expands to a nested object. Fallible because the grammar accepts bracket steps (a[0]=1 parses) that a writer cannot use: an index never reaches the nested-object expansion.

type Error = PathError

The type returned in the event of a conversion error.