Struct miden_assembly::Module

pub struct Module {
    pub path: LibraryPath,
    pub ast: ModuleAst,
}

A module containing its absolute path and parsed AST.

Fields

path: LibraryPath

Absolute path of the module.

ast: ModuleAst

Parsed AST of the module.

Implementations

impl Module

pub const fn new(path: LibraryPath, ast: ModuleAst) -> Self

Create a new module from a path and ast.

pub fn kernel(ast: ModuleAst) -> Self

Create a new kernel module from a AST using the constant LibraryPath::kernel_path.

pub fn check_namespace( &self, namespace: &LibraryNamespace ) -> Result<(), LibraryError>

Validate if the module belongs to the provided namespace.

pub fn clear_locations(&mut self)

Clears the source locations from this module.

pub fn load_source_locations<R: ByteReader>( &mut self, source: &mut R ) -> Result<(), DeserializationError>

Loads the [SourceLocation] of the procedures via ModuleAst::load_source_locations.

pub fn write_source_locations<W: ByteWriter>(&self, target: &mut W)

Writes the [SourceLocation] of the procedures via ModuleAst::write_source_locations.

pub fn write_into<W: ByteWriter>( &self, target: &mut W, options: AstSerdeOptions )

Serialization of Module via LibraryPath::write_into and ModuleAst::write_into. AstSerdeOptions are used to direct serialization of ModuleAst.

pub fn read_from<R: ByteReader>( source: &mut R, options: AstSerdeOptions ) -> Result<Self, DeserializationError>

Deserialization of Module via LibraryPath::read_from and ModuleAst::read_from. AstSerdeOptions are used to direct deserialization of ModuleAst.

Trait Implementations

impl Clone for Module

fn clone(&self) -> Module

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Module

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

Formats the value using the given formatter.

impl Ord for Module

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

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Module

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Module

impl StructuralPartialEq for Module