Enum 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

impl<'a> Component<'a>

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

impl<'a> Arg for Component<'a>

Available on crate feature std only.

fn as_str(&self) -> Result<&str, Errno>

Returns a view of this string as a string slice.

fn to_string_lossy(&self) -> Cow<'_, str>

Returns a potentially-lossy rendering of this string as a Cow<'_, str>.

fn as_cow_c_str(&self) -> Result<Cow<'_, CStr>, Errno>

Returns a view of this string as a maybe-owned CStr.

fn into_c_str<'b>(self) -> Result<Cow<'b, CStr>, Errno>

where Component<'a>: 'b,

Consumes self and returns a view of this string as a maybe-owned CStr.

fn into_with_c_str<T, F>(self, f: F) -> Result<T, Errno>

where Component<'a>: Sized, F: FnOnce(&CStr) -> Result<T, Errno>,

Runs a closure with self passed in as a &CStr.

impl AsRef<OsStr> for Component<'_>

fn as_ref(&self) -> &OsStr

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

impl AsRef<Path> for Component<'_>

fn as_ref(&self) -> &Path

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 duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy 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> Eq for Component<'a>

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, 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

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

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

Equality operator ==.

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

Inequality operator !=.

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

impl<'a> TryFrom<Component<'a>> for UnixComponent<'a>

Available on crate feature std only.

fn try_from( component: Component<'a>, ) -> Result<UnixComponent<'a>, <UnixComponent<'a> as TryFrom<Component<'a>>>::Error>

Attempts to convert a std::path::Component into a UnixComponent, returning a result containing the new component when successful or the original component when failed

Examples

use std::convert::TryFrom;
use std::ffi::OsStr;
use std::path::Component;
use typed_path::UnixComponent;

let component = UnixComponent::try_from(Component::RootDir).unwrap();
assert_eq!(component, UnixComponent::RootDir);

let component = UnixComponent::try_from(Component::CurDir).unwrap();
assert_eq!(component, UnixComponent::CurDir);

let component = UnixComponent::try_from(Component::ParentDir).unwrap();
assert_eq!(component, UnixComponent::ParentDir);

let component = UnixComponent::try_from(Component::Normal(OsStr::new("file.txt"))).unwrap();
assert_eq!(component, UnixComponent::Normal(b"file.txt"));

type Error = Component<'a>

The type returned in the event of a conversion error.

impl<'a> TryFrom<Component<'a>> for WindowsComponent<'a>

Available on crate feature std only.

fn try_from( component: Component<'a>, ) -> Result<WindowsComponent<'a>, <WindowsComponent<'a> as TryFrom<Component<'a>>>::Error>

Attempts to convert a std::path::Component into a WindowsComponent, returning a result containing the new component when successful or the original component when failed

Examples

use std::convert::TryFrom;
use std::ffi::OsStr;
use std::path::Component;
use typed_path::WindowsComponent;

let component = WindowsComponent::try_from(Component::RootDir).unwrap();
assert_eq!(component, WindowsComponent::RootDir);

let component = WindowsComponent::try_from(Component::CurDir).unwrap();
assert_eq!(component, WindowsComponent::CurDir);

let component = WindowsComponent::try_from(Component::ParentDir).unwrap();
assert_eq!(component, WindowsComponent::ParentDir);

let component = WindowsComponent::try_from(Component::Normal(OsStr::new("file.txt"))).unwrap();
assert_eq!(component, WindowsComponent::Normal(b"file.txt"));

Alongside the traditional path components, the Component::Prefix variant is also supported, but only when compiling on Windows. When on a non-Windows platform, the conversion will always fail.

type Error = Component<'a>

The type returned in the event of a conversion error.

impl<'a> TryFrom<UnixComponent<'a>> for Component<'a>

Available on crate feature std only.

fn try_from( component: UnixComponent<'a>, ) -> Result<Component<'a>, <Component<'a> as TryFrom<UnixComponent<'a>>>::Error>

Attempts to convert a UnixComponent into a std::path::Component, returning a result containing the new path when successful or the original path when failed

Examples

use std::convert::TryFrom;
use std::ffi::OsStr;
use std::path::Component;
use typed_path::UnixComponent;

let component = Component::try_from(UnixComponent::RootDir).unwrap();
assert_eq!(component, Component::RootDir);

let component = Component::try_from(UnixComponent::CurDir).unwrap();
assert_eq!(component, Component::CurDir);

let component = Component::try_from(UnixComponent::ParentDir).unwrap();
assert_eq!(component, Component::ParentDir);

let component = Component::try_from(UnixComponent::Normal(b"file.txt")).unwrap();
assert_eq!(component, Component::Normal(OsStr::new("file.txt")));

type Error = UnixComponent<'a>

The type returned in the event of a conversion error.

impl<'a> TryFrom<WindowsComponent<'a>> for Component<'a>

Available on crate feature std only.

fn try_from( component: WindowsComponent<'a>, ) -> Result<Component<'a>, <Component<'a> as TryFrom<WindowsComponent<'a>>>::Error>

Attempts to convert a WindowsComponent into a std::path::Component, returning a result containing the new path when successful or the original path when failed

Examples

use std::convert::TryFrom;
use std::ffi::OsStr;
use std::path::Component;
use typed_path::WindowsComponent;

let component = Component::try_from(WindowsComponent::RootDir).unwrap();
assert_eq!(component, Component::RootDir);

let component = Component::try_from(WindowsComponent::CurDir).unwrap();
assert_eq!(component, Component::CurDir);

let component = Component::try_from(WindowsComponent::ParentDir).unwrap();
assert_eq!(component, Component::ParentDir);

let component = Component::try_from(WindowsComponent::Normal(b"file.txt")).unwrap();
assert_eq!(component, Component::Normal(OsStr::new("file.txt")));

Alongside the traditional path components, the Component::Prefix variant is also supported, but only when compiling on Windows. When on a non-Windows platform, the conversion will always fail.

type Error = WindowsComponent<'a>

The type returned in the event of a conversion error.