Struct EnumConstant

pub struct EnumConstant<T: Copy + 'static> { /* private fields */ }

Metadata for a single enum or bitfield constant.

Returned by EngineEnum::all_constants() and EngineBitfield::all_constants().

Implementations

impl<T> EnumConstant<T>

where T: Copy + Eq + PartialEq + 'static,

pub const fn rust_name(&self) -> &'static str

Rust name of the constant, usually without prefix (e.g. "ESCAPE" for Key::ESCAPE).

For enums, this is the value returned by EngineEnum::as_str() if the value is unique. If multiple enum values share the same ordinal, then this function will return each one separately, while as_str() will return the first one.

pub const fn godot_name(&self) -> &'static str

Godot constant name (e.g. "KEY_ESCAPE" for Key::ESCAPE).

pub const fn value(&self) -> T

The Rust value itself.

Use value().ord() to get the ordinal value.

Trait Implementations

impl<T: Clone + Copy + 'static> Clone for EnumConstant<T>

fn clone(&self) -> EnumConstant<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Copy + 'static> Debug for EnumConstant<T>

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

Formats the value using the given formatter.

impl<T: PartialEq + Copy + 'static> PartialEq for EnumConstant<T>

fn eq(&self, other: &EnumConstant<T>) -> 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<T: Copy + Copy + 'static> Copy for EnumConstant<T>

impl<T: Eq + Copy + 'static> Eq for EnumConstant<T>

impl<T: Copy + 'static> StructuralPartialEq for EnumConstant<T>