Struct forest_ipld::Path

pub struct Path { /* fields omitted */ }

Describes a series of steps across a tree or DAG of Ipld, where each segment in the path is a map key or list index. Path is used in describing progress in a traversal; and can also be used as an instruction for traversing from one Ipld node to another.

Parsing implementation matches go-ipld-prime. Prefixed and suffixed "/" characters are removed. Also multiple "/" characters will be collapsed.

Examples

let mut path: Path = "some/path/1".into();

// Can append segments to the path
path.push(2.into());
assert_eq!(path.to_string(), "some/path/1/2");

// Or combine paths
path.extend(&"other/path".into());
assert_eq!(path.to_string(), "some/path/1/2/other/path");

Implementations

impl Path

pub fn new(segments: Vec<PathSegment>) -> Self

pub fn extend(&mut self, other: &Path)

Extend Path with another Path by cloning and appending PathSegments to segments.

pub fn segments(&self) -> &[PathSegment]

Returns slice of PathSegments of the Path.

pub fn push(&mut self, seg: PathSegment)

Pushes a PathSegment to the end of the Path.

pub fn pop(&mut self) -> Option<PathSegment>

Pops a PathSegment from the end of the path.

Trait Implementations

impl Clone for Path

pub fn clone(&self) -> Path

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Path

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

Formats the value using the given formatter.

impl Default for Path

pub fn default() -> Path

Returns the "default value" for a type.

impl Display for Path

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

Formats the value using the given formatter.

impl<'_> From<&'_ str> for Path

pub fn from(s: &str) -> Self

Performs the conversion.

impl PartialEq<Path> for Path

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Path