Struct midenc_codegen_masm::Import

pub struct Import {
    pub span: SourceSpan,
    pub name: Symbol,
    pub alias: Symbol,
}

This represents an import statement in Miden Assembly

Fields

span: SourceSpan

The source span corresponding to this import statement, if applicable

name: Symbol

The fully-qualified name of the imported module, e.g. std::math::u64

alias: Symbol

The name to which the imported module is aliased locally, e.g. u64 is the alias for use std::math::u64, which is the default behavior.

However, custom aliases are permitted, and we may use this to disambiguate imported modules, e.g. use std::math::u64->my_u64 will result in the alias for this import being my_u64.

Implementations

impl MasmImport

pub fn is_aliased(&self) -> bool

Returns true if this import has a custom alias, or if it uses the default aliasing behavior for imports

pub fn conflicts_with(&self, other: &MasmImport) -> bool

Returns true if this import conflicts with other

A conflict arises when the same name is used to reference two different imports locally within a module, i.e. the aliases conflict

Trait Implementations

impl Clone for MasmImport

fn clone(&self) -> MasmImport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MasmImport

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

Formats the value using the given formatter.

impl FromStr for MasmImport

fn from_str(s: &str) -> Result<MasmImport, <MasmImport as FromStr>::Err>

Parse an import statement as seen in Miden Assembly, e.g. use std::math::u64->bigint

type Err = Error

The associated error which can be returned from parsing.

impl Hash for MasmImport

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 Ord for MasmImport

fn cmp(&self, other: &MasmImport) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for MasmImport

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

fn partial_cmp(&self, other: &MasmImport) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Spanned for MasmImport

fn span(&self) -> SourceSpan

impl TryFrom<Ident> for MasmImport

type Error = Error

The type returned in the event of a conversion error.

fn try_from( module: Ident, ) -> Result<MasmImport, <MasmImport as TryFrom<Ident>>::Error>

Performs the conversion.

impl Copy for MasmImport

impl Eq for MasmImport