EmbeddedEnum

Struct EmbeddedEnum 

Source
pub struct EmbeddedEnum {
    pub id: ModelId,
    pub name: Name,
    pub discriminant: FieldPrimitive,
    pub variants: Vec<EnumVariant>,
    pub fields: Vec<Field>,
    pub indices: Vec<Index>,
}
Expand description

An embedded enum model stored in the parent table via a discriminant column and optional per-variant data columns.

The discriminant column holds a value (integer or string) identifying the active variant. Variants may optionally carry data fields, which are stored as additional nullable columns in the parent table.

§Examples

let ee = model.as_embedded_enum_unwrap();
for variant in &ee.variants {
    println!("variant {} = {}", variant.name.upper_camel_case(), variant.discriminant);
}

Fields§

§id: ModelId

Uniquely identifies this model within the schema.

§name: Name

The model’s name.

§discriminant: FieldPrimitive

The primitive type used for the discriminant column.

§variants: Vec<EnumVariant>

The enum’s variants.

§fields: Vec<Field>

All fields across all variants, with global indices. Each field’s variant identifies which variant it belongs to.

§indices: Vec<Index>

Indices defined on this embedded enum’s variant fields.

These reference fields within this embedded enum (not the parent model). The schema builder propagates them to physical DB indices on the parent table’s flattened columns.

Implementations§

Source§

impl EmbeddedEnum

Source

pub fn has_data_variants(&self) -> bool

Returns true if at least one variant carries data fields.

Source

pub fn variant_fields( &self, variant_index: usize, ) -> impl Iterator<Item = &Field>

Returns fields belonging to a specific variant.

Trait Implementations§

Source§

impl Clone for EmbeddedEnum

Source§

fn clone(&self) -> EmbeddedEnum

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EmbeddedEnum

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.