Struct Function

pub struct Function {
    pub abi_version: AbiVersion,
    pub headers: Arc<[AbiHeaderType]>,
    pub name: Arc<str>,
    pub inputs: Arc<[NamedAbiType]>,
    pub outputs: Arc<[NamedAbiType]>,
    pub input_id: u32,
    pub output_id: u32,
}

Contract method ABI definition.

Fields

abi_version: AbiVersion

ABI version (same as contract ABI version).

headers: Arc<[AbiHeaderType]>

List of headers for external messages. Must be the same as in contract.

NOTE: header order matters.

name: Arc<str>

Method name.

inputs: Arc<[NamedAbiType]>

Method input argument types.

outputs: Arc<[NamedAbiType]>

Method output types.

input_id: u32

Function id in incoming messages (with input).

output_id: u32

Function id in outgoing messages (with output).

Implementations

impl Function

pub const INPUT_ID_MASK: u32 = 2_147_483_647u32

Mask with a bit difference of input id and output id.

pub fn compute_function_id( abi_version: AbiVersion, name: &str, headers: &[AbiHeaderType], inputs: &[NamedAbiType], outputs: &[NamedAbiType], ) -> u32

Computes function id from the full function signature.

pub fn encode_internal_msg_body( version: AbiVersion, id: u32, tokens: &[NamedAbiValue], ) -> Result<CellBuilder>

Encodes message body without headers.

pub fn builder<T: Into<String>>( abi_version: AbiVersion, name: T, ) -> FunctionBuilder

Returns a method builder with the specified ABI version and name.

pub fn encode_external<'f, 'a: 'f>( &'f self, tokens: &'a [NamedAbiValue], ) -> ExternalInput<'_, '_>

Encodes an unsigned body with invocation of this method as an external message.

pub fn decode_external_input( &self, slice: CellSlice<'_>, ) -> Result<Vec<NamedAbiValue>>

Tries to parse input arguments for this method from an external message body.

NOTE: The slice is required to contain nothing other than these arguments.

pub fn decode_external_input_ext( &self, slice: &mut CellSlice<'_>, allow_partial: bool, ) -> Result<Vec<NamedAbiValue>>

Tries to parse input arguments for this method from an external message body.

pub fn encode_internal_input( &self, tokens: &[NamedAbiValue], ) -> Result<CellBuilder>

Encodes a message body with invocation of this method as an internal message.

pub fn encode_internal_message( &self, tokens: &[NamedAbiValue], dst: IntAddr, value: Tokens, bounce: bool, state_init: Option<&StateInit>, ) -> Result<Box<OwnedRelaxedMessage>>

Encodes an internal message with invocation of this method.

pub fn decode_internal_input( &self, slice: CellSlice<'_>, ) -> Result<Vec<NamedAbiValue>>

Tries to parse input arguments for this method from an internal message body.

NOTE: The slice is required to contain nothing other than these arguments.

pub fn decode_internal_input_ext( &self, slice: &mut CellSlice<'_>, allow_partial: bool, ) -> Result<Vec<NamedAbiValue>>

Tries to parse input arguments for this method from an internal message body.

pub fn encode_output(&self, tokens: &[NamedAbiValue]) -> Result<CellBuilder>

Encodes a message body with result of invocation of this method.

pub fn decode_output(&self, slice: CellSlice<'_>) -> Result<Vec<NamedAbiValue>>

Tries to parse output arguments of this method from a message body.

NOTE: The slice is required to contain nothing other than these arguments.

pub fn decode_output_ext( &self, slice: &mut CellSlice<'_>, allow_partial: bool, ) -> Result<Vec<NamedAbiValue>>

Tries to parse output arguments of this method from a message body.

pub fn display_signature(&self) -> impl Display + '_

Returns an object which can be used to display the normalized signature of this method.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.