Enum TypedComponent

pub enum TypedComponent<'a> {
    Unix(UnixComponent<'a>),
    Windows(WindowsComponent<'a>),
}

Byte slice version of std::path::Component that represents either a Unix or Windows path component.

Variants

Unix(UnixComponent<'a>)

Windows(WindowsComponent<'a>)

Implementations

impl<'a> TypedComponent<'a>

pub fn to_path(&self) -> TypedPath<'a>

Returns path representing this specific component.

pub fn as_bytes(&self) -> &'a [u8]

Extracts the underlying [[u8]] slice.

Examples

use typed_path::{TypedComponent, TypedPath};

let path = TypedPath::derive(b"/tmp/foo/../bar.txt");
let components: Vec<_> = path.components().map(|comp| comp.as_bytes()).collect();
assert_eq!(&components, &[
    b"/".as_slice(),
    b"tmp".as_slice(),
    b"foo".as_slice(),
    b"..".as_slice(),
    b"bar.txt".as_slice(),
]);

Examples found in repository

examples/typed.rs (line 8)

fn main() {
    // Try to be smart to figure out the path (Unix or Windows) automatically
    let path = TypedPath::derive(r"/path/to/file.txt");

    for component in path.components() {
        println!("{}", String::from_utf8_lossy(component.as_bytes()));
    }
}

pub fn is_root(&self) -> bool

Returns true if is the root dir component.

Examples

use typed_path::{Component, UnixComponent, TypedComponent};
use std::convert::TryFrom;

let root_dir = TypedComponent::Unix(UnixComponent::try_from(b"/").unwrap());
assert!(root_dir.is_root());

let normal = TypedComponent::Unix(UnixComponent::try_from(b"file.txt").unwrap());
assert!(!normal.is_root());

pub fn is_normal(&self) -> bool

Returns true if is a normal component.

Examples

use typed_path::{Component, UnixComponent, TypedComponent};
use std::convert::TryFrom;

let normal = TypedComponent::Unix(UnixComponent::try_from(b"file.txt").unwrap());
assert!(normal.is_normal());

let root_dir = TypedComponent::Unix(UnixComponent::try_from(b"/").unwrap());
assert!(!root_dir.is_normal());

pub fn as_normal_bytes(&self) -> Option<&[u8]>

Returns bytes if is a normal component.

Examples

use typed_path::{Component, UnixComponent, TypedComponent};
use std::convert::TryFrom;

let normal = TypedComponent::Unix(UnixComponent::try_from(b"file.txt").unwrap());
assert_eq!(normal.as_normal_bytes(), Some(b"file.txt".as_slice()));

let root_dir = TypedComponent::Unix(UnixComponent::try_from(b"/").unwrap());
assert_eq!(root_dir.as_normal_bytes(), None);

pub fn is_parent(&self) -> bool

Returns true if is a parent directory component.

Examples

use typed_path::{Component, UnixComponent, TypedComponent};
use std::convert::TryFrom;

let parent = TypedComponent::Unix(UnixComponent::try_from("..").unwrap());
assert!(parent.is_parent());

let root_dir = TypedComponent::Unix(UnixComponent::try_from("/").unwrap());
assert!(!root_dir.is_parent());

pub fn is_current(&self) -> bool

Returns true if is the current directory component.

Examples

use typed_path::{Component, UnixComponent, TypedComponent};
use std::convert::TryFrom;

let current = TypedComponent::Unix(UnixComponent::try_from(".").unwrap());
assert!(current.is_current());

let root_dir = TypedComponent::Unix(UnixComponent::try_from("/").unwrap());
assert!(!root_dir.is_current());

pub fn len(&self) -> usize

Returns byte length of component.

pub fn is_empty(&self) -> bool

Trait Implementations

impl AsRef<[u8]> for TypedComponent<'_>

fn as_ref(&self) -> &[u8]

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

impl<'a> Clone for TypedComponent<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TypedComponent<'a>

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

Formats the value using the given formatter.

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

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

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

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

impl<'a> Eq for TypedComponent<'a>

impl<'a> StructuralPartialEq for TypedComponent<'a>