Struct hir::Function

pub struct Function { /* private fields */ }

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 ret_type(self, db: &dyn HirDatabase) -> Type

Get this function’s return type

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

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

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( self, db: &dyn HirDatabase, generics: impl Iterator<Item = Type> ) -> Vec<Param>

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

pub fn is_async(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 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) -> 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 ) -> String

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

impl From<Function> for DefWithBody

fn from(it: Function) -> DefWithBody

Converts to this type from the input type.

impl From<Function> for FunctionId

fn from(ty: Function) -> FunctionId

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(id: FunctionId) -> Function

Converts to this type from the input type.

impl HasAttrs for Function

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

impl HasContainer for Function

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

impl HasCrate for Function

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

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::Semantics::source] is preferred when working with crate::Semantics, as that caches the parsed file in the semantics’ cache.

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 HirDisplay for Function

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

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

where Self: Sized,

Returns a Displayable type that is human-readable.

fn display<'a>(&'a self, db: &'a dyn HirDatabase) -> HirDisplayWrapper<'a, 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: &'a dyn HirDatabase, max_size: Option<usize> ) -> HirDisplayWrapper<'a, 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: &'a dyn HirDatabase, limited_size: Option<usize> ) -> HirDisplayWrapper<'a, 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: &'a dyn HirDatabase, module_id: ModuleId, 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: &'a dyn HirDatabase ) -> HirDisplayWrapper<'a, Self>

where Self: Sized,

Returns a String representation of self for test purposes

impl PartialEq for Function

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Function

impl Eq for Function

impl StructuralPartialEq for Function