Struct midenc_hir::ExternalFunction

pub struct ExternalFunction {
    pub id: FunctionIdent,
    pub signature: Signature,
}

An ExternalFunction represents a function whose name and signature are known, but which may or may not be compiled as part of the current translation unit.

When building a Function, we use ExternalFunction to represent references to other functions in the program which are called from its body. One “imports” a function to make it callable.

At link time, we make sure all external function references are either defined in the current program, or are well-known functions that are provided as part of a kernel or standard library in the Miden VM.

Fields

id: FunctionIdent

signature: Signature

Trait Implementations

impl Clone for ExternalFunction

fn clone(&self) -> ExternalFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalFunction

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

Formats the value using the given formatter.

impl Ord for ExternalFunction

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 ExternalFunction

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

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

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 PrettyPrint for ExternalFunction

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 Eq for ExternalFunction

impl StructuralPartialEq for ExternalFunction