Struct TyFunctionDecl 

pub struct TyFunctionDecl {

    pub name: Ident,
    pub body: TyCodeBlock,
    pub parameters: Vec<TyFunctionParameter>,
    pub implementing_type: Option<TyDecl>,
    pub implementing_for: Option<TypeId>,
    pub span: Span,
    pub call_path: CallPath,
    pub attributes: Attributes,
    pub type_parameters: Vec<TypeParameter>,
    pub return_type: GenericArgument,
    pub visibility: Visibility,
    pub is_contract_call: bool,
    pub purity: Purity,
    pub where_clause: Vec<(Ident, Vec<TraitConstraint>)>,
    pub is_trait_method_dummy: bool,
    pub is_type_check_finalized: bool,
    pub kind: TyFunctionDeclKind,
}

Fields

name: Ident

body: TyCodeBlock

parameters: Vec<TyFunctionParameter>

implementing_type: Option<TyDecl>

The TyDecl in which this function is implemented.

For TyFunctionDecls representing declarations of trait or ABI provided functions and methods, this will be the TyDecl::TraitDecl and TyDecl::AbiDecl, respectively.

For TyFunctionDecls representing implementations of functions and methods in trait or self impls, this will be the TyDecl::ImplSelfOrTrait.

For TyFunctionDecls representing function applications, this will always be the TyDecl::ImplSelfOrTrait, even if the called function is a trait or ABI provided function.

None for module functions.

implementing_for: Option<TypeId>

The TypeId of the type that this function is implemented for.

For TyFunctionDecls representing declarations of trait or ABI provided functions and methods, this will be the TypeInfo::UnknownGeneric representing the Self generic parameter.

For TyFunctionDecls representing implementations of functions and methods in trait or self impls, this will be the TypeInfo of the corresponding Self type, e.g., TypeInfo::Struct.

For TyFunctionDecls representing function applications, this will always be the TypeInfo of the corresponding Self type, even if the called function is a trait or ABI provided function.

None for module functions.

span: Span

call_path: CallPath

For module functions, this is the full call path of the function.

Otherwise, the CallPath::prefixes are the prefixes of the module in which the defining TyFunctionDecl is located, and the CallPath::suffix is the function name.

attributes: Attributes

type_parameters: Vec<TypeParameter>

return_type: GenericArgument

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>)>

is_trait_method_dummy: bool

is_type_check_finalized: bool

kind: TyFunctionDeclKind

!!! WARNING !!! This field is currently not reliable. Do not use it to check the function kind. Instead, use the Self::is_default, Self::is_entry, Self::is_main, and Self::is_test methods. TODO: See: https://github.com/FuelLabs/sway/issues/7371 !!! WARNING !!!

Implementations

impl TyFunctionDecl

pub fn to_fn_selector_value_untruncated( &self, handler: &Handler, engines: &Engines, ) -> Result<Vec<u8>, ErrorEmitted>

pub fn to_fn_selector_value( &self, handler: &Handler, engines: &Engines, ) -> Result<[u8; 4], ErrorEmitted>

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, handler: &Handler, engines: &Engines, ) -> Result<String, ErrorEmitted>

pub fn is_default(&self) -> bool

pub fn is_entry(&self) -> bool

Whether or not this function is the default entry point.

pub fn is_main(&self) -> bool

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 trace(&self) -> Option<Trace>

pub fn is_fallback(&self) -> bool

pub fn is_constructor(&self, engines: &Engines, type_id: TypeId) -> Option<bool>

Whether or not this function is a constructor for the type given by type_id.

Returns Some(true) if the function is surely the constructor and Some(false) if it is surely not a constructor, and None if it cannot decide.

pub fn is_from_blanket_impl(&self, engines: &Engines) -> bool

impl TyFunctionDecl

pub fn type_check( handler: &Handler, ctx: TypeCheckContext<'_>, fn_decl: &FunctionDeclaration, is_method: bool, is_in_impl_self: bool, implementing_for: Option<TypeId>, ) -> Result<Self, ErrorEmitted>

pub fn type_check_signature( handler: &Handler, ctx: TypeCheckContext<'_>, fn_decl: &FunctionDeclaration, is_method: bool, is_in_impl_self: bool, implementing_for: Option<TypeId>, ) -> Result<Self, ErrorEmitted>

pub fn type_check_body( handler: &Handler, ctx: TypeCheckContext<'_>, fn_decl: &FunctionDeclaration, ty_fn_decl: &mut Self, ) -> Result<Self, ErrorEmitted>

Trait Implementations

impl Clone for TyFunctionDecl

fn clone(&self) -> TyFunctionDecl

Returns a duplicate 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>) -> Arc<TyFunctionDecl>

fn map<R>( &self, index: &DeclId<TyFunctionDecl>, f: impl FnOnce(&TyFunctionDecl) -> R, ) -> R

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

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

fn map<R>( &self, index: &DeclRef<DeclId<TyFunctionDecl>>, f: impl FnOnce(&TyFunctionDecl) -> R, ) -> R

impl DeclEngineGetParsedDecl<TyFunctionDecl> for DeclEngine

fn get_parsed_decl( &self, decl_id: &DeclId<TyFunctionDecl>, ) -> Option<Declaration>

impl DeclEngineGetParsedDeclId<TyFunctionDecl> for DeclEngine

fn get_parsed_decl_id( &self, decl_id: &DeclId<TyFunctionDecl>, ) -> Option<ParsedDeclId<<TyFunctionDecl as TyDeclParsedType>::ParsedType>>

impl DeclEngineInsert<TyFunctionDecl> for DeclEngine

fn insert( &self, decl: TyFunctionDecl, parsed_decl_id: Option<&ParsedDeclId<<TyFunctionDecl as TyDeclParsedType>::ParsedType>>, ) -> DeclRef<DeclId<TyFunctionDecl>>

impl DeclEngineInsertArc<TyFunctionDecl> for DeclEngine

fn insert_arc( &self, decl: Arc<TyFunctionDecl>, parsed_decl_id: Option<&ParsedDeclId<<TyFunctionDecl as TyDeclParsedType>::ParsedType>>, ) -> DeclRef<DeclId<TyFunctionDecl>>

impl DeclEngineReplace<TyFunctionDecl> for DeclEngine

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

impl<'de> Deserialize<'de> for TyFunctionDecl

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FunctionSignature for TyFunctionDecl

fn parameters(&self) -> &Vec<TyFunctionParameter>

fn return_type(&self) -> &GenericArgument

impl HashWithEngines for TyFunctionDecl

fn hash<H: Hasher>(&self, state: &mut H, engines: &Engines)

impl IsConcrete for TyFunctionDecl

fn is_concrete(&self, engines: &Engines) -> bool

impl Named for TyFunctionDecl

fn name(&self) -> &Ident

impl PartialEqWithEngines for TyFunctionDecl

fn eq(&self, other: &Self, ctx: &PartialEqWithEnginesContext<'_>) -> bool

impl Serialize for TyFunctionDecl

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spanned for TyFunctionDecl

fn span(&self) -> Span

impl TyDeclParsedType for TyFunctionDecl

type ParsedType = FunctionDeclaration

impl DeclEngineIndex<TyFunctionDecl> for DeclEngine

impl EqWithEngines for TyFunctionDecl