Struct MountPath 

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

The place where the plugin mounts Topcoat.

Topcoat always gets the full request path. The plugin never removes the prefix, so declare the Topcoat pages under the prefix.

Contract

• prefix(s) applies the PathPrefix rules, then refuses each reserved namespace r (for example /static) with PathError::Reserved when s == r or s is under r.
• root().templates() == ["/", "/{*path}"].
• prefix(P).templates() == [P, P + "/", P + "/{*path}", "/_topcoat/{*path}"].
• For each raw path p, covers(p) is true if and only if a matchit 0.8.4 router with templates() matches p.

Implementations

impl MountPath

pub const fn root() -> Self

Returns the root mount. Topcoat gets each path that Autumn does not route.

pub fn prefix(prefix: &str) -> Result<Self, PathError>

Returns a mount under prefix, for example /app.

Errors

Returns a PathError when prefix is not a valid prefix or is in a reserved namespace.

pub fn as_str(&self) -> &str

Returns / for the root mount, else the prefix.

pub const fn is_root(&self) -> bool

Returns true for the root mount.

pub const fn as_prefix(&self) -> Option<&PathPrefix>

Returns the prefix, or None for the root mount.

pub fn templates(&self) -> Vec<String>

Returns the axum route templates that the plugin registers, in order.

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

Returns true if one of the plugin route templates matches the raw path path. Autumn routes and excluded prefixes can still take the request.

Trait Implementations

impl Clone for MountPath

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MountPath

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

Formats the value using the given formatter.

impl Default for MountPath

fn default() -> Self

Returns the “default value” for a type.

impl Display for MountPath

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

Formats the value using the given formatter.

impl Eq for MountPath

impl FromStr for MountPath

type Err = PathError

The associated error which can be returned from parsing.

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

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

impl Hash for MountPath

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 PartialEq for MountPath

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MountPath

impl TryFrom<&str> for MountPath

type Error = PathError

The type returned in the event of a conversion error.

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

Performs the conversion.