Enum DocGenError 

pub enum DocGenError {
    MissingAnnotation(&'static str),
    UnknownMetric(&'static str),
    DuplicateAnnotation(&'static str),
}

Error raised when the operator annotations and the catalog disagree — the fail-closed guard against an undocumented (or phantom) instrument shipping.

Variants

MissingAnnotation(&'static str)

A metric in ALL_METRICS has no operator annotation.

UnknownMetric(&'static str)

An annotation names a metric that is not in ALL_METRICS.

DuplicateAnnotation(&'static str)

An annotation names a metric more than once.

Trait Implementations

impl Clone for DocGenError

fn clone(&self) -> DocGenError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocGenError

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

Formats the value using the given formatter.

impl Display for DocGenError

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

Formats the value using the given formatter.

impl Eq for DocGenError

impl Error for DocGenError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for DocGenError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocGenError