Skip to main content

EnumDef

Struct EnumDef 

Source
#[non_exhaustive]
pub struct EnumDef { pub name: String, pub repr: Scalar, pub variants: Vec<Variant>, pub other: Option<String>, pub doc: Option<String>, pub default: Option<String>, pub derives: Vec<Derive>, pub other_doc: Option<String>, }
Expand description

An enumeration of named values, with an optional fallback variant for unlisted values.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: String

The type name.

§repr: Scalar

The value’s type.

§variants: Vec<Variant>

The variants, in declaration order.

§other: Option<String>

The fallback variant, which holds an unlisted value. None means every value is listed.

§doc: Option<String>

Documentation.

§default: Option<String>

The variant marked #[default], which needs an ungated Default derive.

§derives: Vec<Derive>

Derives for this enumeration, written after the module’s.

§other_doc: Option<String>

Documentation for the fallback variant. None writes a general sentence.

Implementations§

Source§

impl EnumDef

Source

pub fn new(name: &str, repr: Scalar, variants: Vec<Variant>) -> Self

An enumeration with no fallback, so it must list every value.

Source

pub fn with_other_doc(self, doc: &str) -> Self

Sets the fallback variant’s documentation.

Source

pub fn with_default(self, variant: &str) -> Self

Marks variant #[default], which the derives must match with an ungated Default.

The variant must be a listed one, not the fallback, which carries a value.

Source

pub fn with_derives(self, derives: Vec<Derive>) -> Self

Sets the derives written on this enumeration, after the module’s.

Source

pub fn with_other(self, other: &str) -> Self

Adds a fallback variant other(repr) that holds any unlisted value.

Source

pub fn with_doc(self, doc: &str) -> Self

Sets the documentation.

Trait Implementations§

Source§

impl Clone for EnumDef

Source§

fn clone(&self) -> EnumDef

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EnumDef

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for EnumDef

Source§

impl PartialEq for EnumDef

Source§

fn eq(&self, other: &EnumDef) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EnumDef

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.