Docs4dev
Docs
rust / latest / std / path / enum.component.html

Enum std::path::Component

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

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>)

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

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 OsStr)

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

source 
impl<'a> Component<'a>
source 
pub fn as_os_str(self) -> &'a OsStr

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

source 
impl AsRef<OsStr> for Component<'_>
source 
fn as_ref(&self) -> &OsStr
Converts this type into a shared reference of the (usually inferred) input type.
1.25.0source 
impl AsRef<Path> for Component<'_>
source 
fn as_ref(&self) -> &Path
Converts this type into a shared reference of the (usually inferred) input type.
source 
impl<'a> Clone for Component<'a>
source 
fn clone(&self) -> Component<'a>
Returns a copy of the value. Read more
source 
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source. Read more
source 
impl<'a> Debug for Component<'a>
source 
fn fmt(&self, f: &mut Formatter<'_>) -> Result
Formats the value using the given formatter. Read more
source 
impl<'a> Hash for Component<'a>
source 
fn hash<__H: Hasher>(&self, state: &mut __H)
Feeds this value into the given Hasher. Read more
1.3.0source 
fn hash_slice<H>(data: &[Self], state: &mut H)
where
    H: Hasher,
    Self: Sized,
Feeds a slice of this type into the given Hasher. Read more
source 
impl<'a> Ord for Component<'a>
source 
fn cmp(&self, other: &Component<'a>) -> Ordering
This method returns an Ordering between self and other. Read more
1.21.0source 
fn max(self, other: Self) -> Self
where
    Self: Sized,
Compares and returns the maximum of two values. Read more
1.21.0source 
fn min(self, other: Self) -> Self
where
    Self: Sized,
Compares and returns the minimum of two values. Read more
1.50.0source 
fn clamp(self, min: Self, max: Self) -> Self
where
    Self: Sized + PartialOrd,
Restrict a value to a certain interval. Read more
source 
impl<'a> PartialEq for Component<'a>
source 
fn eq(&self, other: &Component<'a>) -> bool
This method tests for self and other values to be equal, and is used by ==.
source 
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source 
impl<'a> PartialOrd for Component<'a>
source 
fn partial_cmp(&self, other: &Component<'a>) -> Option<Ordering>
This method returns an ordering between self and other values if one exists. Read more
source 
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self and other) and is used by the < operator. Read more
source 
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
source 
fn gt(&self, other: &Rhs) -> bool
This method tests greater than (for self and other) and is used by the > operator. Read more
source 
fn ge(&self, other: &Rhs) -> bool
This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source 
impl<'a> Copy for Component<'a>
source 
impl<'a> Eq for Component<'a>
source 
impl<'a> StructuralEq for Component<'a>
source 
impl<'a> StructuralPartialEq for Component<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for Component<'a>
impl<'a> Send for Component<'a>
impl<'a> Sync for Component<'a>
impl<'a> Unpin for Component<'a>
impl<'a> UnwindSafe for Component<'a>

Blanket Implementations

source 
impl<T> Any for T
where
    T: 'static + ?Sized,
source 
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source 
impl<T> Borrow<T> for T
where
    T: ?Sized,
source 
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source 
impl<T> BorrowMut<T> for T
where
    T: ?Sized,
source 
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source 
impl<T> From<T> for T
source 
fn from(t: T) -> T

Returns the argument unchanged.

source 
impl<T, U> Into<U> for T
where
    U: From<T>,
source 
fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source 
impl<T> ToOwned for T
where
    T: Clone,
 
type Owned = T
The resulting type after obtaining ownership.
source 
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
source 
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more
source 
impl<T, U> TryFrom<U> for T
where
    U: Into<T>,
 
type Error = Infallible
The type returned in the event of a conversion error.
source 
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
source 
impl<T, U> TryInto<U> for T
where
    U: TryFrom<T>,
 
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
source 
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/path/enum.Component.html