Enum rustdoc_json_types::VariantKind

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

The kind of an Enum Variant and the data specific to it, i.e. fields.

Variants

Plain

A variant with no parentheses

enum Demo {
    PlainVariant,
    PlainWithDiscriminant = 1,
}

Tuple(Vec<Option<Id>>)

A variant with unnamed fields.

All Id’s will point to ItemEnum::StructField. Unlike most of JSON, #[doc(hidden)] fields will be given as None instead of being omitted, because order matters.

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

Struct

A variant with named fields.

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

Fields

fields: Vec<Id>

The list of variants in the enum. All of the corresponding Items are of kind ItemEnum::Variant.

fields_stripped: bool

Whether any variants have been removed from the result, due to being private or hidden.

Trait Implementations

impl Clone for VariantKind

fn clone(&self) -> VariantKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariantKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VariantKind

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for VariantKind

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for VariantKind

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for VariantKind

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 VariantKind

impl StructuralPartialEq for VariantKind

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes

Size for each variant:

• Plain: 0 bytes
• Tuple: 32 bytes
• Struct: 32 bytes