Struct FunctionEntity 

pub struct FunctionEntity {

    pub name: String,
    pub signature: String,
    pub visibility: String,
    pub line_start: usize,
    pub line_end: usize,
    pub is_async: bool,
    pub is_test: bool,
    pub is_static: bool,
    pub is_abstract: bool,
    pub parameters: Vec<Parameter>,
    pub return_type: Option<String>,
    pub doc_comment: Option<String>,
    pub attributes: Vec<String>,
    pub parent_class: Option<String>,
    pub complexity: Option<ComplexityMetrics>,
}

Represents a function/method in any language

Fields

name: String

Function name

signature: String

Full signature (including parameters and return type)

visibility: String

Visibility: “public”, “private”, “protected”, “internal”

line_start: usize

Starting line number (1-indexed)

line_end: usize

Ending line number (1-indexed)

is_async: bool

Is this an async/coroutine function?

is_test: bool

Is this a test function?

is_static: bool

Is this a static method?

is_abstract: bool

Is this an abstract method?

parameters: Vec<Parameter>

Function parameters

return_type: Option<String>

Return type annotation (if available)

doc_comment: Option<String>

Documentation/docstring

attributes: Vec<String>

Decorators/attributes (e.g., @property, @deprecated)

parent_class: Option<String>

Parent class (if this is a method)

complexity: Option<ComplexityMetrics>

Complexity metrics for this function

Implementations

impl FunctionEntity

pub fn new(name: impl Into<String>, line_start: usize, line_end: usize) -> Self

pub fn with_signature(self, sig: impl Into<String>) -> Self

pub fn with_visibility(self, vis: impl Into<String>) -> Self

pub fn async_fn(self) -> Self

pub fn test_fn(self) -> Self

pub fn static_fn(self) -> Self

pub fn abstract_fn(self) -> Self

pub fn with_parameters(self, params: Vec<Parameter>) -> Self

pub fn with_return_type(self, ret: impl Into<String>) -> Self

pub fn with_doc(self, doc: impl Into<String>) -> Self

pub fn with_attributes(self, attrs: Vec<String>) -> Self

pub fn with_parent_class(self, parent: impl Into<String>) -> Self

pub fn with_complexity(self, metrics: ComplexityMetrics) -> Self

pub fn cyclomatic_complexity(&self) -> u32

Get the cyclomatic complexity, returning 1 if not calculated

pub fn complexity_grade(&self) -> char

Get the complexity grade (A-F), returning ‘A’ if not calculated

Trait Implementations

impl Clone for FunctionEntity

fn clone(&self) -> FunctionEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionEntity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionEntity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionEntity

fn eq(&self, other: &FunctionEntity) -> 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 Serialize for FunctionEntity

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FunctionEntity