Struct EnumType 

pub struct EnumType { /* private fields */ }

A combined type alias and constant declaration corresponding to a C-like enumeration.

C-style enumerations are effectively a type alias for an integer type with a limited set of valid values with associated names (referred to as variants of the enum type).

In Miden Assembly, these provide a means for a procedure to declare that it expects an argument of the underlying integral type, but that values other than those of the declared variants are illegal/invalid. Currently, these are unchecked, and are only used to convey semantic information. In the future, we may perform static analysis to try and identify invalid instances of the enumeration when derived from a constant.

Implementations

impl EnumType

pub fn new( visibility: Visibility, name: Ident, ty: Type, variants: impl IntoIterator<Item = Variant>, ) -> EnumType

Construct a new enum type with the given name and variants

The caller is assumed to have already validated that ty is an integral type, and this function will assert that this is the case.

pub fn with_docs(self, docs: Option<Span<String>>) -> EnumType

Adds documentation to this enum declaration.

pub fn with_span(self, span: SourceSpan) -> EnumType

Override the default source span

pub fn is_c_like(&self) -> bool

Returns true if this is a C-style enum where the discriminant is the value

pub fn set_span(&mut self, span: SourceSpan)

Set the source span

pub fn name(&self) -> &Ident

Get the name of this enum type

pub const fn visibility(&self) -> Visibility

Get the visibility of this enum type

pub fn docs(&self) -> Option<Span<&str>>

Returns the documentation associated with this item.

pub fn ty(&self) -> &Type

Get the concrete type of this enum’s variants

pub fn variants(&self) -> &[Variant]

Get the variants of this enum type

pub fn variants_mut(&mut self) -> &mut Vec<Variant>

Get the variants of this enum type, mutably

pub fn into_parts(self) -> (TypeAlias, Vec<Variant>)

Split this definition into its type alias and variant parts

Trait Implementations

impl Clone for EnumType

fn clone(&self) -> EnumType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnumType

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

Formats the value using the given formatter.

impl Eq for EnumType

impl From<EnumType> for Form

fn from(value: EnumType) -> Form

Converts to this type from the input type.

impl From<EnumType> for TypeDecl

fn from(value: EnumType) -> TypeDecl

Converts to this type from the input type.

impl Hash for EnumType

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for EnumType

fn eq(&self, other: &EnumType) -> 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 PrettyPrint for EnumType

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl Spanned for EnumType

fn span(&self) -> SourceSpan