Struct doku::Type

pub struct Type {
    pub comment: Option<&'static str>,
    pub example: Option<&'static str>,
    pub tag: Option<&'static str>,
    pub serializable: bool,
    pub deserializable: bool,
    pub def: TypeDef,
}

Fields

comment: Option<&'static str>

example: Option<&'static str>

tag: Option<&'static str>

When we have an adjacently-tagged enum, this field contains name of the field that should represent that enum’s tag.

E.g. in case of ChangelogEvent with its fancy EventDetails, we’d have tag = Some("details");.

serializable: bool

Whether this type is serializable or not (think #[serde(skip_serializing)]). All types are serializable by default, which is a behavior consistent with Serde.

deserializable: bool

Whether this type is deserializable or not (think #[serde(skip_deserializing)]). All types are deserializable by default, which is a behavior consistent with Serde.

def: TypeDef

Implementations

impl Type

pub fn from_def(def: TypeDef) -> Self

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.