Struct ciruela::VPath

pub struct VPath(_);

Virtual path for uploading images

Basically it's an Arc<PathBuf> so it clones cheaply, but also has convenience methods for extracting features specific to our virtual paths.

The anatomy of the virtual path:

/[key]/[suffix]

Type asserts on the presence of the key and that the path is absolute. Suffix might be of arbitrary length including zero.

Methods

impl VPath

pub fn key(&self) -> &str

Returns a key, i.e. the first component

pub fn key_vpath(&self) -> VPath

Returns a key, i.e. the first component

pub fn level(&self) -> usize

Returns a level of a directory

Level is number of path components not counting a key

pub fn parent_rel(&self) -> &Path

Return parent path relative to a key

Panics

Panics if the directory contains only a key (has single component)

pub fn parent(&self) -> VPath

Return virtual path of the directory

Panics

Panics if the directory contains only a key (has single component)

pub fn suffix(&self) -> &Path

The path relative to the key

pub fn final_name(&self) -> &str

The last component of the directory

Panics

Panics if the path has only one component (the key)

pub fn join<P: AsRef<Path>>(&self, path: P) -> VPath

Join path to the virtual path

Panics

Panics if suffix is invalid: empty, root or has parent .. components

pub fn from<T: Into<PathBuf>>(t: T) -> VPath

Create a virtual path from path

Panics

Panics if path is not absolute or doesn't contain directory components

pub fn try_from<T: Into<PathBuf>>(t: T) -> Result<VPath, PathError>

Create a virtual path from path

pub fn matches_basedir(&self, base_dir: &VPath) -> bool

Check this directory belongs to the specified basedir

Technically the same, but faster version of:

self.parent() == base_dir

Trait Implementations

impl PartialEq for VPath

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for VPath

impl Hash for VPath

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,

Feeds a slice of this type into the given [Hasher].

impl PartialOrd for VPath

fn partial_cmp(&self, other: &VPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &VPath) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &VPath) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &VPath) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &VPath) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for VPath

fn cmp(&self, other: &VPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Clone for VPath

fn clone(&self) -> VPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Borrow<Path> for VPath

fn borrow(&self) -> &Path

Immutably borrows from an owned value.

impl AsRef<Path> for VPath

fn as_ref(&self) -> &Path

Performs the conversion.

impl<'de> Deserialize<'de> for VPath

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

Deserialize this value from the given Serde deserializer.

impl Display for VPath

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

Formats the value using the given formatter.

impl Debug for VPath

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

Formats the value using the given formatter.