Struct Function 

pub struct Function {
    pub(crate) id: AnyFunctionId,
}

Fields

id: AnyFunctionId

Implementations

impl Function

pub fn module(self, db: &dyn HirDatabase) -> Module

pub fn name(self, db: &dyn HirDatabase) -> Name

pub fn ty(self, db: &dyn HirDatabase) -> Type<'_>

pub fn fn_ptr_type(self, db: &dyn HirDatabase) -> Type<'_>

pub(crate) fn fn_sig<'db>( self, db: &'db dyn HirDatabase, ) -> (ParamEnvAndCrate<'db>, PolyFnSig<'db>)

pub fn ret_type(self, db: &dyn HirDatabase) -> Type<'_>

Get this function’s return type

pub fn ret_type_with_args<'db>( self, db: &'db dyn HirDatabase, generics: impl Iterator<Item = Type<'db>>, ) -> Type<'db>

pub(crate) fn adapt_generic_args<'db>( self, interner: DbInterner<'db>, generics: impl Iterator<Item = Type<'db>>, ) -> GenericArgs<'db>

pub fn async_ret_type<'db>(self, db: &'db dyn HirDatabase) -> Option<Type<'db>>

pub fn has_self_param(self, db: &dyn HirDatabase) -> bool

pub fn self_param(self, db: &dyn HirDatabase) -> Option<SelfParam>

pub fn assoc_fn_params(self, db: &dyn HirDatabase) -> Vec<Param<'_>>

pub fn num_params(self, db: &dyn HirDatabase) -> usize

pub fn method_params(self, db: &dyn HirDatabase) -> Option<Vec<Param<'_>>>

pub fn params_without_self(self, db: &dyn HirDatabase) -> Vec<Param<'_>>

pub fn params_without_self_with_args<'db>( self, db: &'db dyn HirDatabase, generics: impl Iterator<Item = Type<'db>>, ) -> Vec<Param<'db>>

pub fn is_const(self, db: &dyn HirDatabase) -> bool

pub fn is_async(self, db: &dyn HirDatabase) -> bool

pub fn is_varargs(self, db: &dyn HirDatabase) -> bool

pub fn extern_block(self, db: &dyn HirDatabase) -> Option<ExternBlock>

pub fn returns_impl_future(self, db: &dyn HirDatabase) -> bool

pub fn is_test(self, db: &dyn HirDatabase) -> bool

Does this function have #[test] attribute?

pub fn is_main(self, db: &dyn HirDatabase) -> bool

is this a fn main or a function with an export_name of main?

pub(crate) fn attrs(self, db: &dyn HirDatabase) -> AttrFlags

pub fn exported_main(self, db: &dyn HirDatabase) -> bool

Is this a function with an export_name of main?

pub fn is_ignore(self, db: &dyn HirDatabase) -> bool

Does this function have the ignore attribute?

pub fn is_bench(self, db: &dyn HirDatabase) -> bool

Does this function have #[bench] attribute?

pub fn is_unstable(self, db: &dyn HirDatabase) -> bool

Is this function marked as unstable with #[feature] attribute?

pub fn is_unsafe_to_call( self, db: &dyn HirDatabase, caller: Option<Function>, call_edition: Edition, ) -> bool

pub fn has_body(self, db: &dyn HirDatabase) -> bool

Whether this function declaration has a definition.

This is false in the case of required (not provided) trait methods.

pub fn as_proc_macro(self, db: &dyn HirDatabase) -> Option<Macro>

pub fn eval( self, db: &dyn HirDatabase, span_formatter: impl Fn(FileId, TextRange) -> String, ) -> Result<String, ConstEvalError>

Trait Implementations

impl AsAssocItem for Function

fn as_assoc_item(self, db: &dyn HirDatabase) -> Option<AssocItem>

impl AsExternAssocItem for Function

fn as_extern_assoc_item(self, db: &dyn HirDatabase) -> Option<ExternAssocItem>

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate 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.

impl From<AnyFunctionId> for Function

fn from(id: AnyFunctionId) -> Function

Converts to this type from the input type.

impl From<Function> for AnyFunctionId

fn from(ty: Function) -> AnyFunctionId

Converts to this type from the input type.

impl From<Function> for DefWithBody

fn from(it: Function) -> DefWithBody

Converts to this type from the input type.

impl From<Function> for GenericDef

fn from(it: Function) -> GenericDef

Converts to this type from the input type.

impl From<Function> for ModuleDef

fn from(it: Function) -> ModuleDef

Converts to this type from the input type.

impl From<FunctionId> for Function

fn from(value: FunctionId) -> Self

Converts to this type from the input type.

impl HasAttrs for Function

fn attrs(self, db: &dyn HirDatabase) -> AttrsWithOwner

fn hir_docs(self, db: &dyn HirDatabase) -> Option<&Docs>

impl HasContainer for Function

fn container(&self, db: &dyn HirDatabase) -> ItemContainer

impl HasCrate for Function

fn krate(&self, db: &dyn HirDatabase) -> Crate

impl HasName for Function

fn name(&self, db: &dyn HirDatabase) -> Option<Name>

impl HasSource for Function

type Ast = Fn

fn source(self, db: &dyn HirDatabase) -> Option<InFile<Self::Ast>>

Fetches the definition’s source node. Using crate::SemanticsImpl::source is preferred when working with crate::Semantics, as that caches the parsed file in the semantics’ cache.

fn source_with_range( self, db: &dyn HirDatabase, ) -> Option<InFile<(TextRange, Option<Self::Ast>)>>

Fetches the source node, along with its full range.

impl HasVisibility for Function

fn visibility(&self, db: &dyn HirDatabase) -> Visibility

fn is_visible_from(&self, db: &dyn HirDatabase, module: Module) -> bool

impl Hash for Function

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'db> HirDisplay<'db> for Function

fn hir_fmt(&self, f: &mut HirFormatter<'_, 'db>) -> Result

fn into_displayable<'a>( &'a self, db: &'db (dyn HirDatabase + 'static), max_size: Option<usize>, limited_size: Option<usize>, omit_verbose_types: bool, display_target: DisplayTarget, display_kind: DisplayKind, closure_style: ClosureStyle, show_container_bounds: bool, ) -> HirDisplayWrapper<'a, 'db, Self>

where Self: Sized,

Returns a Displayable type that is human-readable.

fn display<'a>( &'a self, db: &'db (dyn HirDatabase + 'static), display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, 'db, Self>

where Self: Sized,

Returns a Displayable type that is human-readable. Use this for showing types to the user (e.g. diagnostics)

fn display_truncated<'a>( &'a self, db: &'db (dyn HirDatabase + 'static), max_size: Option<usize>, display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, 'db, Self>

where Self: Sized,

Returns a Displayable type that is human-readable and tries to be succinct. Use this for showing types to the user where space is constrained (e.g. doc popups)

fn display_limited<'a>( &'a self, db: &'db (dyn HirDatabase + 'static), limited_size: Option<usize>, display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, 'db, Self>

where Self: Sized,

Returns a Displayable type that is human-readable and tries to limit the number of items inside. Use this for showing definitions which may contain too many items, like trait, struct, enum

fn display_source_code<'a>( &'a self, db: &'db (dyn HirDatabase + 'static), module_id: ModuleIdLt<'static>, allow_opaque: bool, ) -> Result<String, DisplaySourceCodeError>

Returns a String representation of self that can be inserted into the given module. Use this when generating code (e.g. assists)

fn display_test<'a>( &'a self, db: &'db (dyn HirDatabase + 'static), display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, 'db, Self>

where Self: Sized,

Returns a String representation of self for test purposes

fn display_with_container_bounds<'a>( &'a self, db: &'db (dyn HirDatabase + 'static), show_container_bounds: bool, display_target: DisplayTarget, ) -> HirDisplayWrapper<'a, 'db, Self>

where Self: Sized,

Returns a String representation of self that shows the constraint from the container for functions

impl PartialEq for Function

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<Function> for FunctionId

type Error = ()

The type returned in the event of a conversion error.

fn try_from(v: Function) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Function

impl Eq for Function

impl StructuralPartialEq for Function