Skip to main content

ScriptEnum

Struct ScriptEnum 

Source
pub struct ScriptEnum<'a> {
    pub meta: Option<Meta>,
    pub name: String,
    pub module_name: Option<String>,
    pub visibility: Visibility,
    pub variants: Vec<ScriptEnumVariant<'a>>,
    pub default_variant: Option<u8>,
}
Expand description

An enum a frontend produced.

Installing takes two passes, ScriptEnum::declare then ScriptEnum::define, so that types can refer to each other.

Fields§

§meta: Option<Meta>

Metadata attached to this type.

§name: String

Name to register the type under.

§module_name: Option<String>

Module the type belongs to.

§visibility: Visibility

How widely the type is visible.

§variants: Vec<ScriptEnumVariant<'a>>

Variants, in declaration order.

§default_variant: Option<u8>

Discriminant a default value holds.

Implementations§

Source§

impl ScriptEnum<'_>

Source

pub fn declare(&self, registry: &mut Registry)

Registers the type with no variants yet, so other types can name it.

Source

pub fn define(&self, registry: &mut Registry)

Fills in the variants of an already declared type, in place.

Does nothing when the type was never declared.

Source

pub fn install(&self, registry: &mut Registry)

Registers the type complete with variants, in one pass.

Only works when every field type is already registered. Otherwise use declare and define.

Trait Implementations§

Source§

impl<'a> Debug for ScriptEnum<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ScriptEnum<'a>

§

impl<'a> RefUnwindSafe for ScriptEnum<'a>

§

impl<'a> Send for ScriptEnum<'a>

§

impl<'a> Sync for ScriptEnum<'a>

§

impl<'a> Unpin for ScriptEnum<'a>

§

impl<'a> UnsafeUnpin for ScriptEnum<'a>

§

impl<'a> UnwindSafe for ScriptEnum<'a>

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> Finalize for T

Source§

unsafe fn finalize_raw(data: *mut ())

Drops the value stored at data in place. 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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.