Struct typed_path::windows::Utf8WindowsPrefixComponent

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

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

In addition to the parsed Utf8WindowsPrefix information returned by kind, Utf8WindowsPrefixComponent also holds the raw and unparsed str slice, returned by as_str.

Instances of this struct can be obtained by matching against the Utf8WindowsPrefix variant on Utf8WindowsComponent.

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

Examples

use typed_path::{Utf8WindowsPath, windows::{Utf8WindowsComponent, Utf8WindowsPrefix}};

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

Implementations

impl<'a> Utf8WindowsPrefixComponent<'a>

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

Returns the parsed prefix data

See Utf8WindowsPrefix’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_str(&self) -> &'a str

Returns the raw str slice for this prefix

Examples

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

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

// UNC will include server & share
let component = Utf8WindowsPrefixComponent::try_from(r"\\server\share").unwrap();
assert_eq!(component.as_str(), r"\\server\share");

// Device NS will include device
let component = Utf8WindowsPrefixComponent::try_from(r"\\.\BrainInterface").unwrap();
assert_eq!(component.as_str(), r"\\.\BrainInterface");

// Verbatim will include component
let component = Utf8WindowsPrefixComponent::try_from(r"\\?\pictures").unwrap();
assert_eq!(component.as_str(), r"\\?\pictures");

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

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

pub fn from_utf8(
    component: &WindowsPrefixComponent<'a>
) -> Result<Self, Utf8Error>

Converts a non-UTF-8 WindowsPrefixComponent to a UTF-8 Utf8WindowsPrefixComponent by checking that the component contains valid UTF-8.

Errors

Returns Err if the prefix component is not UTF-8 with a description as to why the provided component is not UTF-8.

See the docs for Utf8Error for more details on the kinds of errors that can be returned.

pub unsafe fn from_utf8_unchecked(
    component: &WindowsPrefixComponent<'a>
) -> Self

Converts a non-UTF-8 WindowsPrefixComponent to a UTF-8 Utf8WindowsPrefixComponent without checking that the string contains valid UTF-8.

See the safe version, from_utf8, for more information.

Safety

The component passed in must be valid UTF-8.

Trait Implementations

impl<'a> Clone for Utf8WindowsPrefixComponent<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Utf8WindowsPrefixComponent<'a>

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

Formats the value using the given formatter.

impl Hash for Utf8WindowsPrefixComponent<'_>

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Utf8WindowsPrefixComponent<'_>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<Utf8WindowsPrefixComponent<'a>> for Utf8WindowsPrefixComponent<'a>

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

fn partial_cmp(&self, other: &Utf8WindowsPrefixComponent<'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> TryFrom<&'a str> for Utf8WindowsPrefixComponent<'a>

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

Parses the str slice into a Utf8WindowsPrefixComponent

Examples

use typed_path::windows::{Utf8WindowsPrefix, Utf8WindowsPrefixComponent};
use std::convert::TryFrom;

let component = Utf8WindowsPrefixComponent::try_from("C:").unwrap();
assert_eq!(component.kind(), Utf8WindowsPrefix::Disk('C'));

let component = Utf8WindowsPrefixComponent::try_from(r"\\.\BrainInterface").unwrap();
assert_eq!(component.kind(), Utf8WindowsPrefix::DeviceNS("BrainInterface"));

let component = Utf8WindowsPrefixComponent::try_from(r"\\server\share").unwrap();
assert_eq!(component.kind(), Utf8WindowsPrefix::UNC("server", "share"));

let component = Utf8WindowsPrefixComponent::try_from(r"\\?\UNC\server\share").unwrap();
assert_eq!(component.kind(), Utf8WindowsPrefix::VerbatimUNC("server", "share"));

let component = Utf8WindowsPrefixComponent::try_from(r"\\?\C:").unwrap();
assert_eq!(component.kind(), Utf8WindowsPrefix::VerbatimDisk('C'));

let component = Utf8WindowsPrefixComponent::try_from(r"\\?\pictures").unwrap();
assert_eq!(component.kind(), Utf8WindowsPrefix::Verbatim("pictures"));

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

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

type Error = &'static str

The type returned in the event of a conversion error.

impl<'a> Copy for Utf8WindowsPrefixComponent<'a>

impl<'a> Eq for Utf8WindowsPrefixComponent<'a>

impl<'a> StructuralEq for Utf8WindowsPrefixComponent<'a>