Enum typed_path::TypedPathBuf

pub enum TypedPathBuf {
    Unix(UnixPathBuf),
    Windows(WindowsPathBuf),
}

Represents a pathbuf with a known type that can be one of:

• UnixPathBuf
• WindowsPathBuf

Variants

Unix(UnixPathBuf)

Windows(WindowsPathBuf)

Implementations

impl TypedPathBuf

pub fn is_unix(&self) -> bool

Returns true if this path represents a Unix path.

pub fn is_windows(&self) -> bool

Returns true if this path represents a Windows path.

pub fn as_path(&self) -> TypedPath<'_>

Converts into a TypedPath.

Trait Implementations

impl<'a> From<&'a [u8]> for TypedPathBuf

fn from(s: &'a [u8]) -> Self

Creates a new typed pathbuf from a byte slice by determining if the path represents a Windows or Unix path. This is accomplished by first trying to parse as a Windows path. If the resulting path contains a prefix such as C: or begins with a \, it is assumed to be a WindowsPathBuf; otherwise, the slice will be represented as a UnixPathBuf.

Examples

use typed_path::TypedPathBuf;

assert!(TypedPathBuf::from(br#"C:\some\path\to\file.txt"#).is_windows());
assert!(TypedPathBuf::from(br#"\some\path\to\file.txt"#).is_windows());
assert!(TypedPathBuf::from(br#"/some/path/to/file.txt"#).is_unix());

// NOTE: If we don't start with a backslash, it's too difficult to
//       determine and we therefore just assume a Unix/POSIX path.
assert!(TypedPathBuf::from(br#"some\path\to\file.txt"#).is_unix());
assert!(TypedPathBuf::from(b"file.txt").is_unix());
assert!(TypedPathBuf::from(b"").is_unix());

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

fn from(s: &'a [u8; N]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a str> for TypedPathBuf

fn from(s: &'a str) -> Self

Converts to this type from the input type.

impl From<String> for TypedPathBuf

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for TypedPathBuf

fn from(s: Vec<u8>) -> Self

Converts to this type from the input type.

impl TryFrom<TypedPathBuf> for PathBuf

type Error = TypedPathBuf

The type returned in the event of a conversion error.

fn try_from(path: TypedPathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TypedPathBuf> for UnixPathBuf

type Error = TypedPathBuf

The type returned in the event of a conversion error.

fn try_from(path: TypedPathBuf) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<TypedPathBuf> for WindowsPathBuf

type Error = TypedPathBuf

The type returned in the event of a conversion error.

fn try_from(path: TypedPathBuf) -> Result<Self, Self::Error>

Performs the conversion.