Struct OpaqueRoute 

#[non_exhaustive]
pub struct OpaqueRoute {
    pub pattern: String,
    pub prefix: Option<String>,
    pub methods: Vec<String>,
    pub reason: OpaqueReason,
    pub note: Option<String>,
}

A route the description cannot express, recorded rather than dropped.

pattern is the router’s own matching syntax, verbatim. It is deliberately not a PathTemplate: minting a template for a catch-all would put a claim in paths that the service does not honour — either about the path, or about a parameter whose value always contains an unescaped /. A consumer gets something visible, greppable and diffable instead of a plausible lie.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pattern: String

The router’s matching pattern, verbatim.

prefix: Option<String>

The literal prefix the pattern is anchored at, if any.

Recorded so that a reader can tell which part of the URL space the route claims without parsing the router’s matching syntax.

methods: Vec<String>

The methods served, spelled as they appear on the wire.

reason: OpaqueReason

Why it cannot be expressed.

note: Option<String>

A human-readable note.

Implementations

impl OpaqueRoute

pub fn new(pattern: impl Into<String>, reason: OpaqueReason) -> Self

Records a route under pattern that cannot be described.

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Records the literal prefix the pattern is anchored at.

pub fn with_methods<I, S>(self, methods: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Records the methods served.

pub fn with_note(self, note: impl Into<String>) -> Self

Records a human-readable note.

pub fn is_annotated(document: &Document) -> bool

Whether document carries the annotation at all.

True even when the value is malformed, for the reason Opaque::is_annotated gives.

pub fn all(document: &Document) -> Result<Vec<Self>, MalformedAnnotation>

Reads every recorded route from a document.

An absent annotation reads as an empty list, since recording nothing is the same claim as recording an empty list.

Errors

Returns MalformedAnnotation when the annotation is present but unreadable. A reason this build does not know is not that case — it round-trips as OpaqueReason::Unrecognized.

pub fn append_to( &self, document: &mut Document, ) -> Result<(), MalformedAnnotation>

Appends this record to a document.

Errors

Returns MalformedAnnotation when the document already carries an unreadable list, rather than replacing it. Appending by overwriting would delete every route someone else recorded — silent loss of exactly the record this mechanism exists to keep.

Panics

Panics only if this record cannot be serialized, which the type makes impossible.

Trait Implementations

impl Clone for OpaqueRoute

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 OpaqueRoute

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpaqueRoute

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for OpaqueRoute

impl PartialEq for OpaqueRoute

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OpaqueRoute

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 OpaqueRoute