Struct sway_core::language::ty::TyFunctionDecl

pub struct TyFunctionDecl {
    pub name: Ident,
    pub body: TyCodeBlock,
    pub parameters: Vec<TyFunctionParameter>,
    pub implementing_type: Option<TyDecl>,
    pub span: Span,
    pub attributes: AttributesMap,
    pub type_parameters: Vec<TypeParameter>,
    pub return_type: TypeArgument,
    pub visibility: Visibility,
    pub is_contract_call: bool,
    pub purity: Purity,
    pub where_clause: Vec<(Ident, Vec<TraitConstraint>)>,
}

Fields

name: Ident

body: TyCodeBlock

parameters: Vec<TyFunctionParameter>

implementing_type: Option<TyDecl>

span: Span

attributes: AttributesMap

type_parameters: Vec<TypeParameter>

return_type: TypeArgument

visibility: Visibility

is_contract_call: bool

whether this function exists in another contract and requires a call to it or not

purity: Purity

where_clause: Vec<(Ident, Vec<TraitConstraint>)>

Implementations

impl TyFunctionDecl

pub fn to_fn_selector_value_untruncated( &self, type_engine: &TypeEngine, decl_engine: &DeclEngine ) -> CompileResult<Vec<u8>>

pub fn to_fn_selector_value( &self, type_engine: &TypeEngine, decl_engine: &DeclEngine ) -> CompileResult<[u8; 4]>

Converts a TyFunctionDecl into a value that is to be used in contract function selectors. Hashes the name and parameters using SHA256, and then truncates to four bytes.

pub fn to_selector_name( &self, type_engine: &TypeEngine, decl_engine: &DeclEngine ) -> CompileResult<String>

pub fn is_main_entry(&self) -> bool

Whether or not this function is the default entry point.

pub fn is_test(&self) -> bool

Whether or not this function is a unit test, i.e. decorated with #[test].

pub fn inline(&self) -> Option<Inline>

pub fn is_entry(&self) -> bool

Whether or not this function describes a program entry point.

impl TyFunctionDecl

pub fn type_check( ctx: TypeCheckContext<'_>, fn_decl: FunctionDeclaration, is_method: bool, is_in_impl_self: bool ) -> CompileResult<Self>

Trait Implementations

impl Clone for TyFunctionDecl

fn clone(&self) -> TyFunctionDecl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TyFunctionDecl

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

Formats the value using the given formatter.

impl DeclEngineGet<DeclId<TyFunctionDecl>, TyFunctionDecl> for DeclEngine

fn get(&self, index: &DeclId<TyFunctionDecl>) -> TyFunctionDecl

impl DeclEngineGet<DeclRef<DeclId<TyFunctionDecl>>, TyFunctionDecl> for DeclEngine

fn get(&self, index: &DeclRef<DeclId<TyFunctionDecl>>) -> TyFunctionDecl

impl DeclEngineInsert<TyFunctionDecl> for DeclEngine

fn insert(&self, decl: TyFunctionDecl) -> DeclRef<DeclId<TyFunctionDecl>>

impl DeclEngineReplace<TyFunctionDecl> for DeclEngine

fn replace(&self, index: DeclId<TyFunctionDecl>, decl: TyFunctionDecl)

impl Named for TyFunctionDecl

fn name(&self) -> &Ident

impl Spanned for TyFunctionDecl

fn span(&self) -> Span

impl DeclEngineIndex<TyFunctionDecl> for DeclEngine