Struct Signature 

pub struct Signature {

    pub name: String,
    pub params: Vec<Parameter>,
    pub ret_ty: Option<MirType>,
    pub ret_signedness: Signedness,
    pub ret_aggregate: Option<Aggregate>,
    pub kernel: Option<KernelMetadata>,
    pub no_inline: bool,
    pub inline_hint: bool,
    pub noreturn: bool,
    pub pure: bool,
    pub visibility: Option<SymbolVisibility>,
    pub placement: Option<CodePlacement>,
    pub weak: bool,
    pub section: Option<String>,
    pub align: Option<u32>,
    pub naked: bool,
    pub variadic: bool,
}

Function signature

Fields

name: String

Function name

params: Vec<Parameter>

Parameters (in order)

ret_ty: Option<MirType>

Return type (None for void)

ret_signedness: Signedness

Signedness of an integer return value

ret_aggregate: Option<Aggregate>

Set when the function returns an aggregate by value. ret_ty is then the pointer to it, and a call’s result register names the caller’s slot for the copy.

kernel: Option<KernelMetadata>

no_inline: bool

Set by @noinline; the inliner must leave calls to this function alone.

inline_hint: bool

Set by @inline; the inliner accepts a larger body than its default size limit.

noreturn: bool

Set by @noreturn; no code after a call to this function is reachable.

pure: bool

Set by @pure or @const; a call whose result is unused can be deleted.

visibility: Option<SymbolVisibility>

Set by @internal, @private, @hidden or @protected.

placement: Option<CodePlacement>

Set by @cold or @hot.

weak: bool

Set by @weak; the symbol is emitted as a weak definition.

section: Option<String>

Set by @section("name"); the function is emitted into that ELF section.

align: Option<u32>

Set by @align(n); the function entry is aligned to n bytes.

naked: bool

Set by @naked; the function is emitted with no prologue or epilogue.

variadic: bool

Set by a trailing ... on an @extern declaration. A call to one follows the variadic side of the platform convention.

Implementations

impl Signature

pub fn new(name: impl Into<String>) -> Self

Creates a void, parameterless, non-kernel signature that the inliner may inline.

pub fn with_kernel(self, metadata: KernelMetadata) -> Self

Marks the function as a GPU kernel, which GPU codegen requires to be void with a single block.

pub fn with_params(self, params: Vec<Parameter>) -> Self

pub fn with_return(self, ty: MirType) -> Self

pub fn with_return_signedness(self, signedness: Signedness) -> Self

pub fn with_return_aggregate(self, aggregate: Aggregate) -> Self

pub fn param_count(&self) -> usize

pub fn is_void(&self) -> bool

True when there is no return value. An aggregate return is not void, since ret_ty then holds the pointer.

Trait Implementations

impl Clone for Signature

fn clone(&self) -> Self

Returns a duplicate 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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Signature