Enum rustdoc_types::Variant

pub enum Variant {
    Plain(Option<Discriminant>),
    Tuple(Vec<Option<Id>>),
    Struct {
        fields: Vec<Id>,
        fields_stripped: bool,
    },
}

Variants

Plain(Option<Discriminant>)

A variant with no parentheses, and possible discriminant.

enum Demo {
    PlainVariant,
    PlainWithDiscriminant = 1,
}

Tuple(Vec<Option<Id>>)

A variant with unnamed fields.

Unlike most of json, #[doc(hidden)] fields will be given as None instead of being ommited, because order matters.

enum Demo {
    TupleVariant(i32),
    EmptyTupleVariant(),
}

Struct

Fields

fields: Vec<Id>

fields_stripped: bool

A variant with named fields.

enum Demo {
    StructVariant { x: i32 },
    EmptyStructVariant {},
}

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.

impl<'de> Deserialize<'de> for Variant

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Variant

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Variant> for Variant

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Variant

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

Serialize this value into the given Serde serializer.

impl Eq for Variant

impl StructuralEq for Variant

impl StructuralPartialEq for Variant