Struct StoragePath 

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

A canonical decoded Pubky storage path that can be encoded as an HTTP/WebDAV URI path.

Percent signs are literal. URL decoding must happen before construction. Paths cannot end in whitespace because storage backends may trim it.

Implementations

impl StoragePath

pub fn new(path: &str) -> Result<Self, StoragePathError>

Parse an already-canonical decoded absolute path.

pub fn normalize(path: &str) -> Result<Self, StoragePathError>

Normalize a decoded absolute HTTP/WebDAV path and validate the result.

pub fn as_str(&self) -> &str

Borrow the decoded canonical path.

pub fn is_root(&self) -> bool

Return whether this path is the storage root.

pub fn is_directory(&self) -> bool

Return whether this path is directory-shaped.

pub fn is_file(&self) -> bool

Return whether this path is file-shaped.

pub fn url_encode(&self) -> String

Encode this decoded path for use as an HTTP URL path.

Trait Implementations

impl AsRef<str> for StoragePath

fn as_ref(&self) -> &str

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

impl Clone for StoragePath

fn clone(&self) -> StoragePath

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoragePath

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StoragePath

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StoragePath

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

Formats the value using the given formatter.

impl Eq for StoragePath

impl FromStr for StoragePath

type Err = StoragePathError

The associated error which can be returned from parsing.

fn from_str(path: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for StoragePath

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 Ord for StoragePath

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

fn eq(&self, other: &StoragePath) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for StoragePath

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StoragePath

impl TryFrom<&str> for StoragePath

type Error = StoragePathError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for StoragePath

type Error = StoragePathError

The type returned in the event of a conversion error.

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

Performs the conversion.