Struct uniffi_bindgen::interface::Enum

pub struct Enum {
    pub(super) name: String,
    pub(super) module_path: String,
    pub(super) discr_type: Option<Type>,
    pub(super) variants: Vec<Variant>,
    pub(super) flat: bool,
    pub(super) non_exhaustive: bool,
    pub(super) docstring: Option<String>,
}

Represents an enum with named variants, each of which may have named and typed fields.

Enums are passed across the FFI by serializing to a bytebuffer, with a i32 indicating the variant followed by the serialization of each field.

Fields

name: String

module_path: String

discr_type: Option<Type>

variants: Vec<Variant>

flat: bool

non_exhaustive: bool

docstring: Option<String>

Implementations

impl Enum

pub fn name(&self) -> &str

pub fn variants(&self) -> &[Variant]

pub fn variant_discr(&self, variant_index: usize) -> Result<Literal>

pub fn variant_discr_type(&self) -> &Option<Type>

pub fn is_flat(&self) -> bool

pub fn is_non_exhaustive(&self) -> bool

pub fn iter_types(&self) -> TypeIterator<'_>

pub fn docstring(&self) -> Option<&str>

pub fn try_from_meta(meta: EnumMetadata, flat: bool) -> Result<Self>

Trait Implementations

impl AsType for Enum

fn as_type(&self) -> Type

impl Checksum for Enum

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

impl Clone for Enum

fn clone(&self) -> Enum

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Enum

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

Formats the value using the given formatter.

impl PartialEq for Enum

fn eq(&self, other: &Enum) -> 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 Eq for Enum

impl StructuralPartialEq for Enum