Struct ra_ap_hir::Function

pub struct Function { /* fields omitted */ }

Implementations

impl Function

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

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

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

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

Get this function’s return type

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

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

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

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

pub fn diagnostics(self, db: &dyn HirDatabase, sink: &mut DiagnosticSink<'_>)

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

A textual representation of the HIR of this function for debugging purposes.

Trait Implementations

impl AsAssocItem for Function

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

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Function

impl Debug for Function

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

Formats the value using the given formatter.

impl Eq for Function

impl From<Function> for ModuleDef

fn from(it: Function) -> ModuleDef

Performs the conversion.

impl From<Function> for DefWithBody

fn from(it: Function) -> DefWithBody

Performs the conversion.

impl From<Function> for GenericDef

fn from(it: Function) -> GenericDef

Performs the conversion.

impl From<FunctionId> for Function

fn from(id: FunctionId) -> Function

Performs the conversion.

impl HasAttrs for Function

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

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

fn resolve_doc_path(
    self,
    db: &dyn HirDatabase,
    link: &str,
    ns: Option<Namespace>
) -> Option<ModuleDef>

impl HasSource for Function

type Ast = Fn

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

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.

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

Feeds a slice of this type into the given Hasher.

impl HirDisplay for Function

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

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

Returns a Displayable type that is human-readable.

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

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

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

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)

pub fn display_source_code(
    &'a self,
    db: &'a (dyn HirDatabase + 'a),
    module_id: ModuleId
) -> 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)

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

Returns a String representation of self for test purposes

impl PartialEq<Function> 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: &Function) -> bool

This method tests for !=.

impl StructuralEq for Function

impl StructuralPartialEq for Function