Struct OrdPath

pub struct OrdPath<E: Encoding, const N: usize> { /* private fields */ }

A slice of an OrdPath.

Implementations

impl<E: Encoding, const N: usize> OrdPath<E, N>

pub fn encoding(&self) -> &E

Returns a reference to the used encoding.

pub fn bytes(&self) -> &Bytes

Produces an iterator over the bytes of an OrdPath.

pub fn ordinals(&self) -> Ordinals<&Bytes, &E>

Produces an iterator over the ordinals of an OrdPath.

pub fn ancestors(&self) -> Ancestors<'_, E, N>

Produces an iterator over OrdPath ancestors.

The iterator will yield the OrdPath that is returned if the [parent] method is used one or more times. If the [parent] method returns None, the iterator will do likewise.

Examples

let path = <OrdPathBuf>::from_ordinals(&[1, 2, 3], DefaultEncoding);
let mut ancestors = path.ancestors();
assert_eq!(ancestors.next().map(|p| p.to_string()), Some("1.2".to_owned()));
assert_eq!(ancestors.next().map(|p| p.to_string()), Some("1".to_owned()));
assert_eq!(ancestors.next().map(|p| p.to_string()), Some("".to_owned()));
assert_eq!(ancestors.next(), None);

pub fn parent(&self) -> Option<&OrdPath<E, N>>

Returns the OrdPath without its final element, if there is one.

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

where E: PartialEq,

Returns true if self is an ancestor of other.

Examples

let a = <OrdPathBuf>::from_ordinals(&[1, 2], DefaultEncoding);
let d = <OrdPathBuf>::from_ordinals(&[1, 2, 3], DefaultEncoding);
assert!(a.is_ancestor_of(&d));

See also OrdPath::is_descendant_of.

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

where E: PartialEq,

Returns true if self is an descendant of other.

Examples

let a = <OrdPathBuf>::from_ordinals(&[1, 2], DefaultEncoding);
let d = <OrdPathBuf>::from_ordinals(&[1, 2, 3], DefaultEncoding);
assert!(d.is_descendant_of(&a));

See also OrdPath::is_ancestor_of.

Trait Implementations

impl<E: Encoding, const N: usize> Borrow<OrdPath<E, N>> for OrdPathBuf<E, N>

fn borrow(&self) -> &OrdPath<E, N>

Immutably borrows from an owned value.

impl<E: Encoding, const N: usize> Debug for OrdPath<E, N>

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

Formats the value using the given formatter.

impl<E: Encoding, const N: usize> Display for OrdPath<E, N>

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

Formats the value using the given formatter.

impl<E: Encoding, const N: usize> Hash for OrdPath<E, N>

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

Feeds this value into the given Hasher.

impl<E: Encoding + PartialEq, const N: usize> PartialEq for OrdPath<E, N>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<E: Encoding + PartialEq, const N: usize> PartialOrd for OrdPath<E, N>

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<E: Encoding + Clone, const N: usize> ToOwned for OrdPath<E, N>

type Owned = OrdPathBuf<E, N>

The resulting type after obtaining ownership.

fn to_owned(&self) -> OrdPathBuf<E, N>

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.