Struct EnumLayout

pub struct EnumLayout<F: Form = MetaForm> { /* private fields */ }

An enum storage layout.

Implementations

impl EnumLayout

pub fn new<N, K, V>(name: N, dispatch_key: K, variants: V) -> Self

where N: Into<<MetaForm as Form>::String>, K: Into<LayoutKey>, V: IntoIterator<Item = (Discriminant, StructLayout)>,

Creates a new enum layout.

impl<F> EnumLayout<F>

where F: Form,

pub fn name(&self) -> &F::String

Returns the name of the field.

pub fn dispatch_key(&self) -> &LayoutKey

Returns the key where the discriminant is stored to dispatch the variants.

pub fn variants(&self) -> &BTreeMap<Discriminant, StructLayout<F>>

Returns the variants of the enum.

Trait Implementations

impl<F: Debug + Form> Debug for EnumLayout<F>

where F::String: Debug,

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

Formats the value using the given formatter.

impl<'de, F: Form> Deserialize<'de> for EnumLayout<F>

where F::Type: DeserializeOwned, F::String: DeserializeOwned,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Form> From<EnumLayout<F>> for Layout<F>

fn from(value: EnumLayout<F>) -> Self

Converts to this type from the input type.

impl IntoPortable for EnumLayout

type Output = EnumLayout<PortableForm>

The portable version of Self.

fn into_portable(self, registry: &mut Registry) -> Self::Output

Convert self to the portable form by using the registry for caching.

impl<F: Form + JsonSchema> JsonSchema for EnumLayout<F>

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<F: Ord + Form> Ord for EnumLayout<F>

where F::String: Ord,

fn cmp(&self, other: &EnumLayout<F>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<F: PartialEq + Form> PartialEq for EnumLayout<F>

where F::String: PartialEq,

fn eq(&self, other: &EnumLayout<F>) -> 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<F: PartialOrd + Form> PartialOrd for EnumLayout<F>

where F::String: PartialOrd,

fn partial_cmp(&self, other: &EnumLayout<F>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<F: Form> Serialize for EnumLayout<F>

where F::Type: Serialize, F::String: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<F: Eq + Form> Eq for EnumLayout<F>

where F::String: Eq,

impl<F: Form> StructuralPartialEq for EnumLayout<F>