Skip to main content

CodeMeta

Struct CodeMeta 

Source
pub struct CodeMeta {
    pub name: &'static str,
    pub category: &'static str,
    pub description: &'static str,
    pub exit_code: Option<i32>,
}
Expand description

Metadata for a single error or warning code.

name doubles as the emitted string value — every code is declared as pub const X: &str = "X" so this field references the same constant the call site uses. Keeping the const + the CodeMeta entry pointing at the same identifier lets a rename flow through both with no drift.

description and category feed the generated docs page (docs/error-codes.data.json, consumed by <ErrorCodesTable>). exit_code is Some(_) only for errors that have a bespoke entry — warnings always set None because they don’t change exit status.

Serialize is derived so the generator binary can emit each entry verbatim via serde_json. Every consuming crate already has serde in its dep tree; adding it here doesn’t grow the compile graph.

Fields§

§name: &'static str§category: &'static str§description: &'static str§exit_code: Option<i32>

Trait Implementations§

Source§

impl Debug for CodeMeta

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for CodeMeta

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.