Enum Component

pub enum Component<'a> {
    CurDir,
    ParentDir,
    Normal(&'a str),
}

A single path component.

Accessed using the RelativePath::components iterator.

Examples

use relative_path::{Component, RelativePath};

let path = RelativePath::new("foo/../bar/./baz");
let mut it = path.components();

assert_eq!(Some(Component::Normal("foo")), it.next());
assert_eq!(Some(Component::ParentDir), it.next());
assert_eq!(Some(Component::Normal("bar")), it.next());
assert_eq!(Some(Component::CurDir), it.next());
assert_eq!(Some(Component::Normal("baz")), it.next());
assert_eq!(None, it.next());

Variants

CurDir

The current directory ..

ParentDir

The parent directory ...

Normal(&'a str)

A normal path component as a string.

Implementations

impl<'a> Component<'a>

pub fn as_str(self) -> &'a str

Extracts the underlying str slice.

Examples

use relative_path::{RelativePath, Component};

let path = RelativePath::new("./tmp/../foo/bar.txt");
let components: Vec<_> = path.components().map(Component::as_str).collect();
assert_eq!(&components, &[".", "tmp", "..", "foo", "bar.txt"]);

Trait Implementations

impl AsRef<RelativePath> for Component<'_>

AsRef<RelativePath> implementation for Component.

Examples

use relative_path::RelativePath;

let mut it = RelativePath::new("../foo/bar").components();

let a = it.next().ok_or("a")?;
let b = it.next().ok_or("b")?;
let c = it.next().ok_or("c")?;

let a: &RelativePath = a.as_ref();
let b: &RelativePath = b.as_ref();
let c: &RelativePath = c.as_ref();

assert_eq!(a, "..");
assert_eq!(b, "foo");
assert_eq!(c, "bar");

fn as_ref(&self) -> &RelativePath

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> Clone for Component<'a>

fn clone(&self) -> Component<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Component<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Component<'a>

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<'a> Ord for Component<'a>

fn cmp(&self, other: &Component<'a>) -> 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.

impl<'a> PartialEq for Component<'a>

fn eq(&self, other: &Component<'a>) -> 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<'a> PartialOrd for Component<'a>

fn partial_cmp(&self, other: &Component<'a>) -> 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<'a> Copy for Component<'a>

impl<'a> Eq for Component<'a>

impl<'a> StructuralPartialEq for Component<'a>