Struct TyFunctionDecl

pub struct TyFunctionDecl {

    pub name: Ident,
    pub body: TyCodeBlock,
    pub parameters: Vec<TyFunctionParameter>,
    pub implementing_type: Option<TyDecl>,
    pub implementing_for_typeid: Option<TypeId>,
    pub span: Span,
    pub call_path: CallPath,
    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>)>,
    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>

implementing_for_typeid: Option<TypeId>

span: Span

call_path: CallPath

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

is_trait_method_dummy: bool

is_type_check_finalized: bool

kind: TyFunctionDeclKind

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_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 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.

impl TyFunctionDecl

pub fn type_check( handler: &Handler, ctx: TypeCheckContext<'_>, fn_decl: &FunctionDeclaration, is_method: bool, is_in_impl_self: bool, implementing_for_typeid: 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_typeid: 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 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>) -> Arc<TyFunctionDecl>

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

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

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 FunctionSignature for TyFunctionDecl

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

fn return_type(&self) -> &TypeArgument

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 Spanned for TyFunctionDecl

fn span(&self) -> Span

impl TyDeclParsedType for TyFunctionDecl

type ParsedType = FunctionDeclaration

impl DeclEngineIndex<TyFunctionDecl> for DeclEngine

impl EqWithEngines for TyFunctionDecl