Trait typed_path::Component

pub trait Component<'a>: AsRef<[u8]> + Clone + Debug + PartialEq + Eq + PartialOrd + Ord + Sealed {
    // Required methods
    fn as_bytes(&self) -> &'a [u8] ;
    fn is_root(&self) -> bool;
    fn is_normal(&self) -> bool;
    fn len(&self) -> usize;

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

Interface representing a component in a Path

Required Methods

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

Extracts the underlying [[u8]] slice

fn is_root(&self) -> bool

Returns true if this component is the root component, meaning there are no more components before this one

Use cases are for the root dir separator on Windows and Unix as well as Windows std::path::PrefixComponent

Examples

/my/../path/./here.txt has the components on Unix of

• UnixComponent::RootDir - is_root() == true
• UnixComponent::ParentDir - is_root() == false
• UnixComponent::CurDir - is_root() == false
• UnixComponent::Normal(b"here.txt") - is_root() == false

fn is_normal(&self) -> bool

Returns true if this component represents a normal part of the path

Examples

/my/../path/./here.txt has the components on Unix of

• UnixComponent::RootDir - is_normal() == false
• UnixComponent::ParentDir - is_normal() == false
• UnixComponent::CurDir - is_normal() == false
• UnixComponent::Normal(b"here.txt") - is_normal() == true

fn len(&self) -> usize

Returns size of component in bytes

Provided Methods

fn is_empty(&self) -> bool

Returns true if component represents an empty byte slice

Implementors

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

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