Enum WindowsComponent

pub enum WindowsComponent<'a> {
    Prefix(WindowsPrefixComponent<'a>),
    RootDir,
    CurDir,
    ParentDir,
    Normal(&'a [u8]),
}

Byte slice version of std::path::Component that represents a Windows-specific component

Variants

Prefix(WindowsPrefixComponent<'a>)

RootDir

CurDir

ParentDir

Normal(&'a [u8])

Implementations

impl<'a> WindowsComponent<'a>

pub fn as_path<T>(&self) -> &Path<T>

where T: Encoding,

Returns path representing this specific component

pub fn is_prefix(&self) -> bool

Returns true if represents a prefix

pub fn prefix(self) -> Option<WindowsPrefixComponent<'a>>

Converts from WindowsComponent to Option<WindowsPrefixComponent>

Converts self into an Option<WindowsPrefixComponent>, consuming self, and discarding if not a WindowsPrefixComponent

pub fn prefix_kind(self) -> Option<WindowsPrefix<'a>>

Converts from WindowsComponent to Option<WindowsPrefix>

Converts self into an Option<WindowsPrefix>, consuming self, and discarding if not a WindowsPrefixComponent whose kind method we invoke

Trait Implementations

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

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

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

impl<T> AsRef<Path<T>> for WindowsComponent<'_>

where T: Encoding,

fn as_ref(&self) -> &Path<T>

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

impl<'a> Clone for WindowsComponent<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Extracts the underlying [[u8]] slice

Examples

use typed_path::{Component, WindowsPath};

let path = WindowsPath::new(br"C:\tmp\foo\..\bar.txt");
let components: Vec<_> = path.components().map(|comp| comp.as_bytes()).collect();
assert_eq!(&components, &[
    b"C:".as_slice(),
    br"\".as_slice(),
    b"tmp".as_slice(),
    b"foo".as_slice(),
    b"..".as_slice(),
    b"bar.txt".as_slice(),
]);

fn is_root(&self) -> bool

Root is one of two situations

• Is the root separator, e.g. \windows
• Is a non-disk prefix, e.g. \\server\share

Examples

use typed_path::{Component, WindowsComponent};
use std::convert::TryFrom;

let root_dir = WindowsComponent::try_from(br"\").unwrap();
assert!(root_dir.is_root());

let non_disk_prefix = WindowsComponent::try_from(br"\\?\pictures").unwrap();
assert!(non_disk_prefix.is_root());

let disk_prefix = WindowsComponent::try_from(b"C:").unwrap();
assert!(!disk_prefix.is_root());

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

fn is_normal(&self) -> bool

Returns true if component is normal

Examples

use typed_path::{Component, WindowsComponent};
use std::convert::TryFrom;

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

let root_dir = WindowsComponent::try_from(br"\").unwrap();
assert!(!root_dir.is_normal());

fn is_parent(&self) -> bool

Returns true if is a parent directory component

Examples

use typed_path::{Component, WindowsComponent};
use std::convert::TryFrom;

let parent = WindowsComponent::try_from("..").unwrap();
assert!(parent.is_parent());

let root_dir = WindowsComponent::try_from(r"\").unwrap();
assert!(!root_dir.is_parent());

fn is_current(&self) -> bool

Returns true if is the current directory component

Examples

use typed_path::{Component, WindowsComponent};
use std::convert::TryFrom;

let current = WindowsComponent::try_from(".").unwrap();
assert!(current.is_current());

let root_dir = WindowsComponent::try_from(r"\").unwrap();
assert!(!root_dir.is_current());

fn is_valid(&self) -> bool

Returns true if this component is valid.

A component can only be invalid if it represents a normal component with bytes that are disallowed by the encoding.

Examples

use typed_path::{Component, WindowsComponent};
use std::convert::TryFrom;

assert!(WindowsComponent::try_from("c:").unwrap().is_valid());
assert!(WindowsComponent::RootDir.is_valid());
assert!(WindowsComponent::ParentDir.is_valid());
assert!(WindowsComponent::CurDir.is_valid());
assert!(WindowsComponent::Normal(b"abc").is_valid());
assert!(!WindowsComponent::Normal(b"|").is_valid());

fn root() -> Self

Returns the root directory component.

Examples

use typed_path::{Component, WindowsComponent};

assert_eq!(WindowsComponent::root(), WindowsComponent::RootDir);

fn parent() -> Self

Returns the parent directory component.

Examples

use typed_path::{Component, WindowsComponent};

assert_eq!(WindowsComponent::parent(), WindowsComponent::ParentDir);

fn current() -> Self

Returns the current directory component.

Examples

use typed_path::{Component, WindowsComponent};

assert_eq!(WindowsComponent::current(), WindowsComponent::CurDir);

fn len(&self) -> usize

Returns size of component in bytes

fn is_empty(&self) -> bool

Returns true if component represents an empty byte slice

impl<'a> Debug for WindowsComponent<'a>

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

Formats the value using the given formatter.

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

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

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

fn partial_cmp(&self, other: &WindowsComponent<'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> TryFrom<&'a [u8]> for WindowsComponent<'a>

fn try_from(path: &'a [u8]) -> Result<Self, Self::Error>

Parses the byte slice into a WindowsComponent

Examples

use typed_path::{WindowsComponent, WindowsPrefix};
use std::convert::TryFrom;

// Supports parsing Windows prefixes
let component = WindowsComponent::try_from(b"c:").unwrap();
assert_eq!(component.prefix_kind(), Some(WindowsPrefix::Disk(b'C')));

// Supports parsing standard windows path components
assert_eq!(WindowsComponent::try_from(br"\"), Ok(WindowsComponent::RootDir));
assert_eq!(WindowsComponent::try_from(b"."), Ok(WindowsComponent::CurDir));
assert_eq!(WindowsComponent::try_from(b".."), Ok(WindowsComponent::ParentDir));
assert_eq!(WindowsComponent::try_from(br"file.txt"), Ok(WindowsComponent::Normal(b"file.txt")));
assert_eq!(WindowsComponent::try_from(br"dir\"), Ok(WindowsComponent::Normal(b"dir")));

// Parsing more than one component will fail
assert!(WindowsComponent::try_from(br"\file").is_err());

type Error = &'static str

The type returned in the event of a conversion error.

impl<'a, const N: usize> TryFrom<&'a [u8; N]> for WindowsComponent<'a>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(path: &'a [u8; N]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a str> for WindowsComponent<'a>

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(path: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

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

fn try_from(component: Component<'a>) -> Result<Self, Self::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<WindowsComponent<'a>> for Component<'a>

fn try_from(component: WindowsComponent<'a>) -> Result<Self, Self::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.

impl<'a> Copy for WindowsComponent<'a>

impl<'a> Eq for WindowsComponent<'a>

impl<'a> StructuralPartialEq for WindowsComponent<'a>