Struct ElementPath 

pub struct ElementPath { /* private fields */ }

Identify an element by its path from the top level down; the empty path is the root level, never an element.

Implementations

impl ElementPath

pub fn root() -> Self

Return the root path, the empty path of the top-level view.

pub fn from_segments<I, S>(segments: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Build a path from its segments, outermost first.

pub fn child(&self, segment: impl Into<String>) -> Self

Return the path of the child segment one level below this path.

pub fn enclosing_level(&self) -> Self

Return the level this path is drawn in: its parent, or the root for a top-level element and for the root itself.

pub fn parent(&self) -> Option<Self>

Return the path one level up, or None for the root.

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

Tell whether self is a proper prefix of other.

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

Tell whether other is self, its ancestor or its descendant.

pub fn lowest_common_ancestor(&self, other: &Self) -> Self

Return the longest common prefix of both paths.

pub fn ancestors(&self) -> impl Iterator<Item = Self> + '_

Yield every proper non-root prefix, outermost first: the elements that must exist for this one to exist.

pub fn ancestor_or_self_at_depth(&self, depth: usize) -> Self

Return the prefix of depth segments: the ancestor at that depth, or the path itself at its own depth.

pub fn truncated_to_depth(&self, depth: usize) -> Self

Return this path truncated to at most depth segments: its ancestor at that depth, or itself when it is no deeper.

pub fn is_component_id(text: &str) -> bool

Tell whether text follows the component id rules: ASCII letters, digits, _ and single inner -, starting with a letter or _.

pub fn is_root(&self) -> bool

Tell whether this is the root path.

pub fn depth(&self) -> usize

Return the path’s depth, its segment count: 0 for the root.

pub fn name(&self) -> Option<&str>

Return the last segment, the element’s own id, or None for the root.

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

Return the path’s segments, outermost first.

Trait Implementations

impl Clone for ElementPath

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 ElementPath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElementPath

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for ElementPath

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

Formats the value using the given formatter.

impl Eq for ElementPath

impl FromStr for ElementPath

type Err = PathParseError

The associated error which can be returned from parsing.

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

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

impl Hash for ElementPath

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 Ord for ElementPath

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ElementPath

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ElementPath

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ElementPath

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ElementPath