Struct doku::Variant

pub struct Variant {
    pub id: &'static str,
    pub title: &'static str,
    pub comment: Option<&'static str>,
    pub serializable: bool,
    pub deserializable: bool,
    pub fields: Fields,
}

Defines a single enum’s variant.

For instance, given this enum:

#[derive(Serialize)]
enum Subject {
    /// Picture of a cat
    #[serde(rename = "picture-of-cat")]
    PictureOfCat,
}

… the Subject::PictureOfCat variant is defined as:

Variant {
    id: "picture-of-cat",
    title: "PictureOfCat",
    comment: Some("Picture of a cat"),
    serializable: true,
    deserializable: true,
    fields: Fields::Unit,
}

When no #[serde(rename = ...)] (or similar) has been provided, id is equal to title.

Fields

id: &'static str

Identifier of the variant; it includes #[serde(rename)] and similar attributes, so this string is exactly what gets serialized into the output.

title: &'static str

Title of the variant as it was written in the Rust code, excluding stuff like #[serde(rename)].

comment: Option<&'static str>

serializable: bool

deserializable: bool

fields: Fields

Trait Implementations

impl Clone for Variant

fn clone(&self) -> Variant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Variant

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

Formats the value using the given formatter.