Struct cbindgen::EnumConfig

pub struct EnumConfig {

    pub rename_variants: RenameRule,
    pub rename_variant_name_fields: RenameRule,
    pub add_sentinel: bool,
    pub prefix_with_name: bool,
    pub derive_helper_methods: bool,
    pub derive_const_casts: bool,
    pub derive_mut_casts: bool,
    pub cast_assert_name: Option<String>,
    pub must_use: Option<String>,
    pub deprecated: Option<String>,
    pub deprecated_with_note: Option<String>,
    pub derive_tagged_enum_destructor: bool,
    pub derive_tagged_enum_copy_constructor: bool,
    pub derive_tagged_enum_copy_assignment: bool,
    pub derive_ostream: bool,
    pub enum_class: bool,
    pub private_default_tagged_enum_constructor: bool,
}

Settings to apply to generated enums.

Fields

rename_variants: RenameRule

The rename rule to apply to the name of enum variants

rename_variant_name_fields: RenameRule

The rename rule to apply to the names of the union fields in C/C++ generated from the Rust enum. Applied before rename_variants rename rule. Defaults to SnakeCase.

add_sentinel: bool

Whether to add a Sentinel value at the end of every enum This is useful in Gecko for IPC serialization

prefix_with_name: bool

Whether the enum variants should be prefixed with the enum name

derive_helper_methods: bool

Whether to generate static ::X(..) constructors and IsX() methods for tagged enums.

derive_const_casts: bool

Whether to generate AsX() const methods for tagged enums.

derive_mut_casts: bool

Whether to generate AsX() methods for tagged enums.

cast_assert_name: Option<String>

The name of the macro to use for derive_{const,mut}casts. If custom, you’re responsible to provide the necessary header, otherwise assert will be used, and <cassert> will be included.

must_use: Option<String>

The way to annotation this enum as #[must_use].

deprecated: Option<String>

The way to annotation this function as #[deprecated] without notes

deprecated_with_note: Option<String>

The way to annotation this function as #[deprecated] with notes

derive_tagged_enum_destructor: bool

Whether to generate destructors of tagged enums.

derive_tagged_enum_copy_constructor: bool

Whether to generate copy-constructors of tagged enums.

derive_tagged_enum_copy_assignment: bool

Whether to generate copy-assignment operators of tagged enums.

This is only generated if a copy constructor for the same tagged enum is generated as well.

derive_ostream: bool

Whether to generate a ostream serializer for the struct

enum_class: bool

Declare the enum as an enum class. Only relevant when targeting C++.

private_default_tagged_enum_constructor: bool

Whether to generate empty, private default-constructors for tagged enums.

Trait Implementations

impl Clone for EnumConfig

fn clone(&self) -> EnumConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnumConfig

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

Formats the value using the given formatter.

impl Default for EnumConfig

fn default() -> EnumConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EnumConfigwhere EnumConfig: Default,

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

Deserialize this value from the given Serde deserializer.