Struct CodeInfo 

pub struct CodeInfo {
    pub code: &'static str,
    pub description: Option<&'static str>,
}

One code a rejection family can resolve to, with its operator-facing text.

use errlanes::{CodeInfo, Rejection, RejectionCode};

fn describe<R: Rejection>() -> Vec<String> {
    <R::Code as RejectionCode>::CODES
        .iter()
        .map(|CodeInfo { code, description }| {
            format!("{code}: {}", description.unwrap_or("(undocumented)"))
        })
        .collect()
}

Fields

code: &'static str

The wire identity, exactly what Into<&'static str> on the Code yields.

description: Option<&'static str>

From #[rejection(description = "..")], else the first paragraph of the leaf’s /// doc comment, else None. Never the #[error("..")] literal: that is a Display template, not prose.

Trait Implementations

impl Clone for CodeInfo

fn clone(&self) -> CodeInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CodeInfo

impl Debug for CodeInfo

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

Formats the value using the given formatter.

impl Eq for CodeInfo

impl Hash for CodeInfo

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 CodeInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CodeInfo