Struct TypeAlias 

pub struct TypeAlias {
    pub visibility: Visibility,
    pub name: Ident,
    pub ty: TypeExpr,
    /* private fields */
}

A TypeAlias represents a named [Type].

Type aliases correspond to type declarations in Miden Assembly source files. They are called aliases, rather than declarations, as the type system for Miden Assembly is structural, rather than nominal, and so two aliases with the same underlying type are considered equivalent.

Fields

visibility: Visibility

The visibility of this type alias

name: Ident

The name of this type alias

ty: TypeExpr

The concrete underlying type

Implementations

impl TypeAlias

pub fn new(visibility: Visibility, name: Ident, ty: TypeExpr) -> Self

Create a new type alias from a name and type

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

Adds documentation to this type alias

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

Override the default source span

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

Set the source span

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

Returns the documentation associated with this item.

pub fn name(&self) -> &Ident

Get the name of this type alias

pub const fn visibility(&self) -> Visibility

Get the visibility of this type alias

Trait Implementations

impl Clone for TypeAlias

fn clone(&self) -> TypeAlias

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeAlias

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

Formats the value using the given formatter.

impl From<TypeAlias> for Form

fn from(value: TypeAlias) -> Self

Converts to this type from the input type.

impl From<TypeAlias> for TypeDecl

fn from(value: TypeAlias) -> Self

Converts to this type from the input type.

impl Hash for TypeAlias

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

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 TypeAlias

fn eq(&self, other: &Self) -> 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 TypeAlias

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 TypeAlias

fn span(&self) -> SourceSpan

impl Eq for TypeAlias