Struct Procedure 

pub struct Procedure { /* private fields */ }

Represents a concrete procedure definition in Miden Assembly syntax

Implementations

impl Procedure

Construction

pub fn new( span: SourceSpan, visibility: Visibility, name: ProcedureName, num_locals: u16, body: Block, ) -> Procedure

Creates a new Procedure from the given source span, visibility, name, number of locals, and code block.

pub fn with_signature(self, ty: FunctionType) -> Procedure

Specify the type signature of this procedure

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

Adds documentation to this procedure definition

pub fn with_attributes<I>(self, attrs: I) -> Procedure

where I: IntoIterator<Item = Attribute>,

Adds attributes to this procedure definition

pub fn set_visibility(&mut self, visibility: Visibility)

Override the visibility of this procedure.

pub fn set_signature(&mut self, signature: FunctionType)

Override the type signature of this procedure.

impl Procedure

Metadata

pub fn name(&self) -> &ProcedureName

Returns the name of this procedure within its containing module.

pub fn visibility(&self) -> Visibility

Returns the visibility of this procedure

pub fn signature(&self) -> Option<&FunctionType>

Get the type signature of this procedure, if known

pub fn signature_mut(&mut self) -> Option<&mut FunctionType>

Get the type signature of this procedure mutably, if known

pub fn num_locals(&self) -> u16

Returns the number of locals allocated by this procedure.

pub fn is_entrypoint(&self) -> bool

Returns true if this procedure corresponds to the begin..end block of an executable module.

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

Returns the documentation for this procedure, if present.

pub fn attributes(&self) -> &AttributeSet

Get the attributes attached to this procedure

pub fn attributes_mut(&mut self) -> &mut AttributeSet

Get the attributes attached to this procedure, mutably

pub fn has_attribute(&self, name: impl AsRef<str>) -> bool

Returns true if this procedure has an attribute named name

pub fn get_attribute(&self, name: impl AsRef<str>) -> Option<&Attribute>

Returns the attribute named name, if present

pub fn body(&self) -> &Block

Returns a reference to the Block containing the body of this procedure.

pub fn body_mut(&mut self) -> &mut Block

Returns a mutable reference to the Block containing the body of this procedure.

pub fn iter(&self) -> Iter<'_, Op>

Returns an iterator over the operations of the top-level Block of this procedure.

pub fn invoked<'a, 'b>(&'b self) -> impl Iterator<Item = &'a Invoke> + 'a

where 'b: 'a,

Returns an iterator over the set of invocation targets of this procedure, i.e. the callees of any call instructions in the body of this procedure.

pub fn extend_invoked<I>(&mut self, iter: I)

where I: IntoIterator<Item = Invoke>,

Extends the set of procedures known to be invoked by this procedure.

This is for internal use only, and is called during semantic analysis once we’ve identified the set of invoked procedures for a given definition.

Trait Implementations

impl Clone for Procedure

fn clone(&self) -> Procedure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Procedure

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

Formats the value using the given formatter.

impl PartialEq for Procedure

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

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 Procedure

fn span(&self) -> SourceSpan

impl Eq for Procedure