Struct EnumBinding 

pub struct EnumBinding {
    pub name: String,
    pub doc: Option<String>,
    pub deprecated: Option<String>,
    pub c_tag: String,
    pub variants: Vec<EnumVariantBinding>,
    pub rich: bool,
}

An enum, fully lowered.

A C-style enum (every variant a bare discriminant) crosses the ABI by value as an integer. An algebraic (rich) enum, at least one variant with associated data, is a value type exactly like a struct: it crosses the ABI serialized in a value buffer as an i32 tag followed by the active variant’s fields in declaration order. Either way, the C header still emits the discriminant constants (EnumVariantBinding::c_const) so C consumers can switch on the value or tag.

Fields

name: String

The enum name as written in the IDL.

doc: Option<String>

Optional doc comment carried from the IDL.

deprecated: Option<String>

Deprecation message when the enum is marked deprecated, else None.

c_tag: String

{prefix}_{module_path}_{name}.

variants: Vec<EnumVariantBinding>

Every variant, in declaration order.

rich: bool

true when this is a rich (algebraic) sum-type enum: at least one variant carries fields, and values cross the ABI as buffers.

Implementations

impl EnumBinding

pub fn is_rich(&self) -> bool

true when this is a rich (algebraic) sum-type enum.

Trait Implementations

impl Clone for EnumBinding

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnumBinding

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

Formats the value using the given formatter.

impl Eq for EnumBinding

impl PartialEq for EnumBinding

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EnumBinding