Struct IPR 

pub struct IPR(/* private fields */);

Internal Path Representation.

They obey the following rules:

• Valid UTF-8
• Are path-separated with /
• Do not begin or end with /
• Do not contain . or .. segments
• Do not contain multiple / characters right next to each other

We can actually infallibly convert to these constraints as long as the input we’re working with is already UTF-8, which Rust strings are! It’s worthwhile to note that this is actually much pickier in certain ways than actual UNIX paths, and you may find some imports fail when dealing with non-unicode paths. The official dirtabase/ark policy for these situations is “we aren’t making stuff for your use case.”

Implementations

impl IPR

pub fn is_well_formed(src: &str) -> bool

Quick check to see if a string already meets requirements.

pub fn canonize<'a>(src: &'a str) -> Cow<'a, str>

Produce a &str in IPR form.

Reuses original string if it’s already suitable. Hence the Cow.

pub fn force_canonize(src: &str) -> String

Produce an owned String in IPR form.

Doesn’t short-circuit to reuse existing memory. Just always charges forward with a statically compiled regex and gets ’er done.

Trait Implementations

impl AsRef<str> for IPR

fn as_ref(&self) -> &str

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

impl Clone for IPR

fn clone(&self) -> IPR

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IPR

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IPR

fn deserialize<D>( deserializer: D, ) -> Result<IPR, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&&str> for IPR

fn from(other: &&str) -> IPR

Converts to this type from the input type.

impl From<&String> for IPR

fn from(other: &String) -> IPR

Converts to this type from the input type.

impl From<&str> for IPR

fn from(other: &str) -> IPR

Converts to this type from the input type.

impl From<String> for IPR

fn from(other: String) -> IPR

Converts to this type from the input type.

impl Hash for IPR

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 IPR

fn cmp(&self, other: &IPR) -> 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<T> PartialEq<T> for IPR

where T: ToIPR,

fn eq(&self, other: &T) -> 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 PartialEq for IPR

fn eq(&self, other: &IPR) -> 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 PartialOrd for IPR

fn partial_cmp(&self, other: &IPR) -> 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 Serialize for IPR

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Path> for IPR

type Error = NonUnicodePath

The type returned in the event of a conversion error.

fn try_from(other: &Path) -> Result<IPR, <IPR as TryFrom<&Path>>::Error>

Performs the conversion.

impl TryFrom<PathBuf> for IPR

type Error = NonUnicodePath

The type returned in the event of a conversion error.

fn try_from(other: PathBuf) -> Result<IPR, <IPR as TryFrom<PathBuf>>::Error>

Performs the conversion.

impl Eq for IPR

impl StructuralPartialEq for IPR