Struct ArgumentPath 

pub struct ArgumentPath(/* private fields */);

An owned path identifying an argument or one of its nested components.

The path is stored exactly as supplied; this type does not parse or normalize separators.

Examples

use qubit_argument::ArgumentPath;

let path = ArgumentPath::new("value").with_prefix("user");
assert_eq!(path.as_str(), "user.value");

#![deny(unused_must_use)]
use qubit_argument::ArgumentPath;

ArgumentPath::new("value");

Implementations

impl ArgumentPath

pub fn new(path: &str) -> Self

Creates an argument path by copying path without normalization.

Parameters

• path: The path text to store.

Returns

A new owned argument path.

pub fn as_str(&self) -> &str

Returns the stored path text.

The returned string slice remains valid for the lifetime of this path.

pub fn with_prefix(self, prefix: &str) -> Self

Prepends a parent path component to this path.

Parameters

• prefix: The parent path to place before the stored path.

Returns

The composed path. Non-empty components are separated by one dot. If either component is empty, no separator is added.

Trait Implementations

impl AsRef<str> for ArgumentPath

fn as_ref(&self) -> &str

Borrows the stored path as a string slice.

Returns

The stored path text, borrowed from self.

impl Clone for ArgumentPath

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentPath

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

Formats the value using the given formatter.

impl Display for ArgumentPath

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

Writes the stored path text without additional decoration.

Parameters

• formatter: The destination that receives the stored path text.

Returns

Ok(()) after writing the text.

Errors

Returns the formatting error produced by the destination if writing the text fails.

impl Eq for ArgumentPath

impl Hash for ArgumentPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ArgumentPath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ArgumentPath