Struct FunctionSignature 

pub struct FunctionSignature {
    pub meta: Option<Meta>,
    pub name: String,
    pub module_name: Option<String>,
    pub type_handle: Option<TypeHandle>,
    pub visibility: Visibility,
    pub inputs: Vec<FunctionParameter>,
    pub outputs: Vec<FunctionParameter>,
}

Everything about a function except its body.

The signature is also the identity of a function: a registry refuses to hold two functions whose signatures are equal.

type_handle is set when the function belongs to a type, which is how methods are modelled.

Fields

meta: Option<Meta>

Metadata attached to this function.

name: String

Name the function is registered under.

module_name: Option<String>

Module the function belongs to.

type_handle: Option<TypeHandle>

Type the function is a method of, if any.

visibility: Visibility

How widely the function is visible.

inputs: Vec<FunctionParameter>

Arguments, in declaration order.

outputs: Vec<FunctionParameter>

Results, in declaration order.

Implementations

impl FunctionSignature

pub fn new(name: impl ToString) -> Self

Builds a signature with just a name.

pub fn with_meta(self, meta: Meta) -> Self

Attaches metadata, builder style.

pub fn with_module_name(self, name: impl ToString) -> Self

Sets the owning module, builder style.

pub fn with_type_handle(self, handle: TypeHandle) -> Self

Makes this a method of the given type, builder style.

pub fn with_visibility(self, visibility: Visibility) -> Self

Sets visibility, builder style.

pub fn with_input(self, parameter: FunctionParameter) -> Self

Appends an input, builder style.

pub fn with_output(self, parameter: FunctionParameter) -> Self

Appends an output, builder style.

Trait Implementations

impl Clone for FunctionSignature

fn clone(&self) -> FunctionSignature

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionSignature

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

Formats the value using the given formatter.

impl Display for FunctionSignature

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

Formats the value using the given formatter.

impl PartialEq for FunctionSignature

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for FunctionSignature