Struct FunctionDescriptor 

pub struct FunctionDescriptor {
    pub hir_id: HirId,
    pub name: String,
    pub visibility: FnVisibility,
    pub is_async: bool,
    pub is_const: bool,
    pub is_unsafe: bool,
    pub generics: Option<String>,
    pub where_clause: Option<String>,
    pub parameters: Vec<FunctionParameter>,
    pub return_type: Option<TypeExpr>,
    pub signature: String,
    pub fqn: String,
}

Rich metadata extracted for each Rust function encountered in the HIR.

Fields

hir_id: HirId

HIR identifier for the function node.

name: String

Short name as written in source (no qualification).

visibility: FnVisibility

Module/impl/trait context owning the function. Visibility as declared (pub, pub(crate), etc.).

is_async: bool

Whether the function is marked async.

is_const: bool

Whether the function is marked const.

is_unsafe: bool

Whether the function is marked unsafe.

generics: Option<String>

Generic parameter clause (<T: Foo>), if present.

where_clause: Option<String>

Optional where clause.

parameters: Vec<FunctionParameter>

Ordered function parameters.

return_type: Option<TypeExpr>

Parsed return type, if any.

signature: String

Textual signature up to (but not including) the body.

fqn: String

Fully-qualified name derived from the owner chain.

Implementations

impl FunctionDescriptor

pub fn from_hir<'tcx>( unit: CompileUnit<'tcx>, node: &HirNode<'tcx>, fqn: String, ) -> Option<Self>

Trait Implementations

impl Clone for FunctionDescriptor

fn clone(&self) -> FunctionDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionDescriptor

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

Formats the value using the given formatter.