Struct typed_path::windows::WindowsPrefixComponent

pub struct WindowsPrefixComponent<'a> { /* private fields */ }

A structure wrapping a Windows path prefix as well as its unparsed string representation. Byte slice version of std::path::PrefixComponent.

In addition to the parsed WindowsPrefix information returned by kind, WindowsPrefixComponent also holds the raw and unparsed [[u8]] slice, returned by as_bytes.

Instances of this struct can be obtained by matching against the WindowsPrefix variant on WindowsComponent.

This is available for use on all platforms despite being a Windows-specific format.

Examples

use typed_path::{WindowsPath, windows::{WindowsComponent, WindowsPrefix}};

let path = WindowsPath::new(r"c:\you\later\");
match path.components().next().unwrap() {
    WindowsComponent::Prefix(prefix_component) => {
        // Notice that the disk kind uses an uppercase letter, but the raw slice
        // underneath has a lowercase drive letter
        assert_eq!(WindowsPrefix::Disk(b'C'), prefix_component.kind());
        assert_eq!(b"c:".as_slice(), prefix_component.as_bytes());
    }
    _ => unreachable!(),
}

Implementations

impl<'a> WindowsPrefixComponent<'a>

pub fn kind(&self) -> WindowsPrefix<'a>

Returns the parsed prefix data

See WindowsPrefix’s documentation for more information on the different kinds of prefixes.

pub fn len(&self) -> usize

Returns the size of the prefix in bytes

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

Returns the raw [[u8]] slice for this prefix

Examples

use typed_path::windows::WindowsPrefixComponent;
use std::convert::TryFrom;

// Disk will include the drive letter and :
let component = WindowsPrefixComponent::try_from(b"C:").unwrap();
assert_eq!(component.as_bytes(), b"C:");

// UNC will include server & share
let component = WindowsPrefixComponent::try_from(br"\\server\share").unwrap();
assert_eq!(component.as_bytes(), br"\\server\share");

// Device NS will include device
let component = WindowsPrefixComponent::try_from(br"\\.\BrainInterface").unwrap();
assert_eq!(component.as_bytes(), br"\\.\BrainInterface");

// Verbatim will include component
let component = WindowsPrefixComponent::try_from(br"\\?\pictures").unwrap();
assert_eq!(component.as_bytes(), br"\\?\pictures");

// Verbatim UNC will include server & share
let component = WindowsPrefixComponent::try_from(br"\\?\UNC\server\share").unwrap();
assert_eq!(component.as_bytes(), br"\\?\UNC\server\share");

// Verbatim disk will include drive letter and :
let component = WindowsPrefixComponent::try_from(br"\\?\C:").unwrap();
assert_eq!(component.as_bytes(), br"\\?\C:");

Trait Implementations

impl<'a> Clone for WindowsPrefixComponent<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for WindowsPrefixComponent<'a>

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

Formats the value using the given formatter.

impl Hash for WindowsPrefixComponent<'_>

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for WindowsPrefixComponent<'_>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl<'a> PartialEq<WindowsPrefixComponent<'a>> for WindowsPrefixComponent<'a>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd<WindowsPrefixComponent<'a>> for WindowsPrefixComponent<'a>

fn partial_cmp(&self, other: &WindowsPrefixComponent<'a>) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'a, const N: usize> TryFrom<&'a [u8; N]> for WindowsPrefixComponent<'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 [u8]> for WindowsPrefixComponent<'a>

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

Parses the byte slice into a WindowsPrefixComponent

Examples

use typed_path::windows::{WindowsPrefix, WindowsPrefixComponent};
use std::convert::TryFrom;

let component = WindowsPrefixComponent::try_from(b"C:").unwrap();
assert_eq!(component.kind(), WindowsPrefix::Disk(b'C'));

let component = WindowsPrefixComponent::try_from(br"\\.\BrainInterface").unwrap();
assert_eq!(component.kind(), WindowsPrefix::DeviceNS(b"BrainInterface"));

let component = WindowsPrefixComponent::try_from(br"\\server\share").unwrap();
assert_eq!(component.kind(), WindowsPrefix::UNC(b"server", b"share"));

let component = WindowsPrefixComponent::try_from(br"\\?\UNC\server\share").unwrap();
assert_eq!(component.kind(), WindowsPrefix::VerbatimUNC(b"server", b"share"));

let component = WindowsPrefixComponent::try_from(br"\\?\C:").unwrap();
assert_eq!(component.kind(), WindowsPrefix::VerbatimDisk(b'C'));

let component = WindowsPrefixComponent::try_from(br"\\?\pictures").unwrap();
assert_eq!(component.kind(), WindowsPrefix::Verbatim(b"pictures"));

// Parsing something that is not a prefix will fail
assert!(WindowsPrefixComponent::try_from(b"hello").is_err());

// Parsing more than a prefix will fail
assert!(WindowsPrefixComponent::try_from(br"C:\path").is_err());

type Error = &'static str

The type returned in the event of a conversion error.

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

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> Copy for WindowsPrefixComponent<'a>

impl<'a> Eq for WindowsPrefixComponent<'a>

impl<'a> StructuralEq for WindowsPrefixComponent<'a>