Struct midenc_hir::Signature

pub struct Signature {
    pub params: Vec<AbiParam>,
    pub results: Vec<AbiParam>,
    pub cc: CallConv,
    pub linkage: Linkage,
}

A Signature represents the type, ABI, and linkage of a function.

A function signature provides us with all of the necessary detail to correctly validate and emit code for a function, whether from the perspective of a caller, or the callee.

Fields

params: Vec<AbiParam>

The arguments expected by this function

results: Vec<AbiParam>

The results returned by this function

cc: CallConv

The calling convention that applies to this function

linkage: Linkage

The linkage that should be used for this function

Implementations

impl Signature

pub fn new<P: IntoIterator<Item = AbiParam>, R: IntoIterator<Item = AbiParam>>( params: P, results: R, ) -> Self

Create a new signature with the given parameter and result types, for a public function using the SystemV calling convention

pub fn is_public(&self) -> bool

Returns true if this function is externally visible

pub fn is_private(&self) -> bool

Returns true if this function is only visible within it’s containing module

pub fn is_kernel(&self) -> bool

Returns true if this function is a kernel function

pub fn arity(&self) -> usize

Returns the number of arguments expected by this function

pub fn params(&self) -> &[AbiParam]

Returns a slice containing the parameters for this function

pub fn param(&self, index: usize) -> Option<&AbiParam>

Returns the parameter at index, if present

pub fn results(&self) -> &[AbiParam]

Returns a slice containing the results of this function

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl PartialEq for Signature

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 Signature

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 Signature