Enum Utf8Component

pub enum Utf8Component<'a> {
    Prefix(Utf8PrefixComponent<'a>),
    RootDir,
    CurDir,
    ParentDir,
    Normal(&'a str),
}

A single component of a path.

A Utf8Component roughly corresponds to a substring between path separators (/ or \).

This enum is created by iterating over Utf8Components, which in turn is created by the components method on Utf8Path.

Examples

use camino::{Utf8Component, Utf8Path};

let path = Utf8Path::new("/tmp/foo/bar.txt");
let components = path.components().collect::<Vec<_>>();
assert_eq!(&components, &[
    Utf8Component::RootDir,
    Utf8Component::Normal("tmp"),
    Utf8Component::Normal("foo"),
    Utf8Component::Normal("bar.txt"),
]);

Variants

Prefix(Utf8PrefixComponent<'a>)

A Windows path prefix, e.g., C: or \\server\share.

There is a large variety of prefix types, see Utf8Prefix’s documentation for more.

Does not occur on Unix.

RootDir

The root directory component, appears after any prefix and before anything else.

It represents a separator that designates that a path starts from root.

CurDir

A reference to the current directory, i.e., ..

ParentDir

A reference to the parent directory, i.e., ...

Normal(&'a str)

A normal component, e.g., a and b in a/b.

This variant is the most common one, it represents references to files or directories.

Implementations

impl<'a> Utf8Component<'a>

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

Extracts the underlying str slice.

Examples

use camino::Utf8Path;

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

pub fn as_os_str(&self) -> &'a OsStr

Extracts the underlying OsStr slice.

Examples

use camino::Utf8Path;

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

Trait Implementations

impl AsRef<OsStr> for Utf8Component<'_>

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for Utf8Component<'_>

fn as_ref(&self) -> &Path

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

impl AsRef<Utf8Path> for Utf8Component<'_>

fn as_ref(&self) -> &Utf8Path

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

impl AsRef<str> for Utf8Component<'_>

fn as_ref(&self) -> &str

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

impl<'a> Clone for Utf8Component<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Utf8Component<'_>

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

Formats the value using the given formatter.

impl Display for Utf8Component<'_>

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

Formats the value using the given formatter.

impl<'a> Hash for Utf8Component<'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 Utf8Component<'a>

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

fn eq(&self, other: &Utf8Component<'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 Utf8Component<'a>

fn partial_cmp(&self, other: &Utf8Component<'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 Utf8Component<'a>

impl<'a> Eq for Utf8Component<'a>

impl<'a> StructuralPartialEq for Utf8Component<'a>