W3cubDocs

/Rust

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

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.

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

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

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

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

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> [src]

[src]

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> Copy for Component<'a> [src]

impl<'a> Clone for Component<'a> [src]

[src]

Returns a copy of the value. Read more

[src]

Performs copy-assignment from source. Read more

impl<'a> PartialEq for Component<'a> [src]

[src]

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

[src]

This method tests for !=.

impl<'a> Eq for Component<'a> [src]

impl<'a> PartialOrd for Component<'a> [src]

[src]

This method returns an ordering between self and other values if one exists. Read more

[src]

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

[src]

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

[src]

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

[src]

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

impl<'a> Ord for Component<'a> [src]

[src]

This method returns an Ordering between self and other. Read more

1.21.0
[src]

Compares and returns the maximum of two values. Read more

1.21.0
[src]

Compares and returns the minimum of two values. Read more

impl<'a> Hash for Component<'a> [src]

[src]

Feeds this value into the given [Hasher]. Read more

1.3.0
[src]

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

impl<'a> Debug for Component<'a> [src]

[src]

Formats the value using the given formatter. Read more

impl<'a> AsRef<OsStr> for Component<'a> [src]

[src]

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