Enum async_std::path::Component

pub enum Component<'a> {
    Prefix(PrefixComponent<'a>),
    RootDir,
    CurDir,
    ParentDir,
    Normal(&'a OsStr),
}

This is supported on unstable only.

A single component of a path.

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

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

Examples

use std::path::{Component, Path};

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

Variants

Prefix(PrefixComponent<'a>)

This is supported on unstable only.

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

There is a large variety of prefix types, see Prefix's documentation for more.

Does not occur on Unix.

RootDir

This is supported on unstable only.

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

This is supported on unstable only.

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

ParentDir

This is supported on unstable only.

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

Normal(&'a OsStr)

This is supported on unstable only.

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.

Methods

impl<'a> Component<'a>

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

This is supported on unstable only.

Extracts the underlying OsStr slice.

Examples

use std::path::Path;

let path = Path::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<'a> Eq for Component<'a>

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

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

Formats the value using the given formatter.

impl<'a> Copy for Component<'a>

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

fn eq(&self, other: &Component<'a>) -> bool

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

fn ne(&self, other: &Component<'a>) -> bool

This method tests for !=.

impl<'_> AsRef<OsStr> for Component<'_>

fn as_ref(&self) -> &OsStr

Performs the conversion.

impl<'_> AsRef<Path> for Component<'_>

fn as_ref(&self) -> &Path

Performs the conversion.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

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

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

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a> PartialOrd<Component<'a>> 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: &Component<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Component<'a>) -> bool

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

fn gt(&self, other: &Component<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Component<'a>) -> bool

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