Struct SchemaEnum 

pub struct SchemaEnum {
    pub dbg_name: String,
    pub variants: Vec<Variant>,
    pub discriminant_size: u8,
    /* private fields */
}

Schema for an enum.

An enum is serialized as its u8 variant discriminant followed by all the field for that variant. The name of each variant, as well as its order in the enum (the discriminant), is significant. The memory format is given by ‘has_explicit_repr’, ‘discriminant_size’, ‘size’, ‘alignment’ and the vairous variants.

Note: If ‘has_explicit_repr’ is false, the memory format is unspecified.

Fields

dbg_name: String

Diagnostic name

variants: Vec<Variant>

Variants of enum

discriminant_size: u8

If this is a repr(uX)-enum, then the size of the discriminant, in bytes. Valid values are 1, 2, or 4. Otherwise, this is the number of bytes needed to represent the discriminant. In either case, this is the size of the enum in the disk-format.

Implementations

impl SchemaEnum

pub fn new( dbg_name: String, discriminant_size: u8, variants: Vec<Variant>, ) -> SchemaEnum

Create a new SchemaEnum instance. Arguments:

• dbg_name - Name of the enum type.
• discriminant_size: If this is a repr(uX)-enum, then the size of the discriminant, in bytes. Valid values are 1, 2, or 4. Otherwise, this is the number of bytes needed to represent the discriminant. In either case, this is the size of the enum in the disk-format.
• variants - The variants of the enum

pub fn new_unsafe( dbg_name: String, variants: Vec<Variant>, discriminant_size: u8, has_explicit_repr: bool, size: Option<usize>, alignment: Option<usize>, ) -> SchemaEnum

Create a new SchemaEnum instance. Arguments:

• dbg_name - Name of the enum type.
• variants - The variants of the enum
• discriminant_size: If this is a repr(uX)-enum, then the size of the discriminant, in bytes. Valid values are 1, 2, or 4. Otherwise, this is the number of bytes needed to represent the discriminant. In either case, this is the size of the enum in the disk-format.
• has_explicit_repr: True if this enum type has a repr(uX) attribute, and thus a predictable memory layout.
• size: The size of the enum (std::mem::size_of::<TheEnum>()), if known
• alignment: The alignment of the enum (std::mem::align_of::<TheEnum>())

Safety

The argument ‘has_explicit_repr’ must only be true if the enum in fact has a #[repr(uX)] attribute. The size and alignment must be correct for the type.

Trait Implementations

impl Clone for SchemaEnum

fn clone(&self) -> SchemaEnum

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaEnum

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

Formats the value using the given formatter.

impl Deserialize for SchemaEnum

fn deserialize( deserializer: &mut Deserializer<'_, impl Read>, ) -> Result<Self, SavefileError>

Deserialize and return an instance of Self from the given deserializer.

impl Packed for SchemaEnum

unsafe fn repr_c_optimization_safe(_version: u32) -> IsPacked

This method returns true if the optimization is allowed for the protocol version given as an argument. This may return true if and only if the given protocol version has a serialized format identical to the memory layout of the given protocol version. Note, the only memory layout existing is that of the most recent version, so Packed-optimization only works when disk-format is identical to memory version.

impl PartialEq for SchemaEnum

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

fn serialize( &self, serializer: &mut Serializer<'_, impl Write>, ) -> Result<(), SavefileError>

Serialize self into the given serializer.

impl WithSchema for SchemaEnum

fn schema(_version: u32, _context: &mut WithSchemaContext) -> Schema

Returns a representation of the schema used by this Serialize implementation for the given version. The WithSchemaContext can be used to guard against recursive data structures. See documentation of WithSchemaContext.

impl StructuralPartialEq for SchemaEnum