Struct Mount 

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

A normalised mount path: absolute, without a trailing slash, without . or ...

Normalisation is idempotent and total — an unacceptable path is refused rather than repaired, because a mount is intent and a guess at intent is how a surface ends up somewhere nobody meant.

use majordomus_cli::web::model::Mount;
assert_eq!(Mount::parse("/tests/").unwrap().as_str(), "/tests");
assert_eq!(Mount::parse("/").unwrap().as_str(), "/");
assert_eq!(Mount::parse("tests").unwrap().as_str(), "/tests");
assert!(Mount::parse("/a/../b").is_err());
assert!(Mount::parse("//a").is_err());

Implementations

impl Mount

pub fn root() -> Self

The root mount, which owns everything no other surface owns.

pub fn parse(raw: &str) -> Result<Self, String>

Parse and normalise a mount path, or say why it is not one.

use majordomus_cli::web::model::Mount;
// normalisation is idempotent
let once = Mount::parse("/benchmarks/").unwrap();
let twice = Mount::parse(once.as_str()).unwrap();
assert_eq!(once, twice);

pub fn as_str(&self) -> &str

The mount as it is written in a route table.

pub fn is_root(&self) -> bool

Is this the root mount, the one surface allowed to answer what nothing else claims?

pub fn prefix(&self) -> String

The prefix a request path must carry to belong to this mount, with its trailing slash.

use majordomus_cli::web::model::Mount;
assert_eq!(Mount::parse("/tests").unwrap().prefix(), "/tests/");
assert_eq!(Mount::root().prefix(), "/");

pub fn owns(&self, path: &str) -> bool

Does this mount own path — the mount itself, or anything below it?

use majordomus_cli::web::model::Mount;
let m = Mount::parse("/tests").unwrap();
assert!(m.owns("/tests"));
assert!(m.owns("/tests/"));
assert!(m.owns("/tests/coverage/index.html"));
assert!(!m.owns("/tests-of-something"));
assert!(Mount::root().owns("/anything"));

pub fn contains(&self, other: &Mount) -> bool

Is other inside this mount? The root contains everything, itself included.

use majordomus_cli::web::model::Mount;
let outer = Mount::parse("/tests").unwrap();
let inner = Mount::parse("/tests/coverage").unwrap();
assert!(outer.contains(&inner));
assert!(!inner.contains(&outer));

pub fn relative(&self) -> String

The path under a destination root this mount composes into, relative and without a leading slash: the root mount composes into the destination itself.

use majordomus_cli::web::model::Mount;
assert_eq!(Mount::parse("/tests").unwrap().relative(), "tests");
assert_eq!(Mount::root().relative(), "");

Trait Implementations

impl Clone for Mount

fn clone(&self) -> Mount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Mount

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Mount

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Mount

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

Formats the value using the given formatter.

impl Eq for Mount

impl From<Mount> for String

fn from(value: Mount) -> Self

Converts to this type from the input type.

impl Hash for Mount

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 JsonSchema for Mount

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for Mount

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

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

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

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 Mount

impl TryFrom<String> for Mount

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.