Enum OpaqueReason 

#[non_exhaustive]
pub enum OpaqueReason {
    UntypedLayer,
    UntypedRoute,
    UntypedHandler,
    ProtocolUpgrade,
    StaticAssets,
    Unrecognized(String),
}

Why part of a service is not verifiably described.

Deliberately not Copy: the wire form has to survive a description written by a newer Kynos, which means carrying a reason this build does not know as Unrecognized rather than failing to read the record at all.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UntypedLayer

A layer of undeclared effect covers the operation.

It may short-circuit, rewrite the body, or add headers, and its type says nothing about which.

UntypedRoute

The route’s matching pattern is not a legal path template.

A catch-all is the usual case: it matches a set of paths that no single template describes.

UntypedHandler

The route’s handler declares neither its inputs nor its responses.

ProtocolUpgrade

The route leaves HTTP, so no version of the specification covers it.

OpenAPI describes request/response semantics. A connection that has upgraded away from HTTP has no vocabulary here, and inventing one would produce an entry no consumer could act on.

StaticAssets

The route serves a tree of files whose membership is not fixed.

A catch-all like every other, so UntypedRoute would be true of it — but it reads identically to a business API someone wildcarded, and the two deserve different amounts of alarm. A consumer meeting this knows the undescribed part of the service is a directory of files rather than an operation nobody wrote down, and a CI gate can tolerate exactly this one.

Unrecognized(String)

A reason recorded by a version of Kynos that knows more than this one.

Preserved verbatim so the record round-trips. An older reader must not turn a description it merely does not fully understand into one it reports as malformed – and must not drop the reason when it writes the document back out.

Implementations

impl OpaqueReason

pub fn as_str(&self) -> &str

The reason as it is spelled in the description.

Trait Implementations

impl Clone for OpaqueReason

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 OpaqueReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OpaqueReason

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OpaqueReason

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

Formats the value using the given formatter.

impl Eq for OpaqueReason

impl Hash for OpaqueReason

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 OpaqueReason

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for OpaqueReason

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 OpaqueReason