Struct Path

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

A web-based URL path.

Validation

A path will never be empty and will always start with a ‘/’.

The path string can contain any US-ASCII letter, number, or punctuation char excluding ‘?’, and ‘#’ since these chars denote the end of the path in the URL.

Implementations

impl<'a> Path<'a>

Construction

pub unsafe fn new(path: &'a str) -> Self

Creates a new path.

Safety

The path must be valid.

impl<'a> Path<'a>

Validation

pub fn is_valid(path: &str) -> bool

Checks if the path is valid.

impl<'a> Path<'a>

Display

pub const fn as_str(&self) -> &str

Gets the path string.

impl<'a> Path<'a>

Segments

pub const fn iter_segments(&self) -> impl Iterator<Item = &'a str>

Creates a new iterator for the path segments.

Example

"/a/b/c/" -> ["a", "b", "c", ""]

Trait Implementations

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

fn as_ref(&self) -> &str

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

impl<'a> Clone for Path<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Path<'a>

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

Formats the value using the given formatter.

impl Default for Path<'static>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Display for Path<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Path<'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> Ord for Path<'a>

fn cmp(&self, other: &Path<'a>) -> 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<'a> PartialEq for Path<'a>

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

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<'a> Copy for Path<'a>

impl<'a> Eq for Path<'a>

impl<'a> StructuralPartialEq for Path<'a>