Struct redox_path::RedoxReference

pub struct RedoxReference<'a>(/* private fields */);

The part of a path that is sent to each scheme

Implementations

impl<'a> RedoxReference<'a>

pub fn new<S: Into<Cow<'a, str>>>(reference: S) -> Option<Self>

Create a new RedoxReference, ensuring there are no invalid characters

pub fn join<S: Into<Cow<'a, str>>>(&self, path: S) -> Option<Self>

Join a RedoxReference with a path. Relative paths will be joined, absolute paths will be returned as-is.

Returns Some on success and None if the path is not valid

pub fn canonical(&self) -> Option<Self>

Canonicalize RedoxReference, removing . and ..

Returns Some on success and None if the path is not valid

pub fn is_canon(&self) -> bool

Verify that the reference is canonicalized

Trait Implementations

impl<'a> AsRef<str> for RedoxReference<'a>

fn as_ref(&self) -> &str

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

impl<'a> Clone for RedoxReference<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RedoxReference<'a>

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

Formats the value using the given formatter.

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

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

impl<'a> StructuralPartialEq for RedoxReference<'a>