Struct FuncSpace 

pub struct FuncSpace {
    pub name: Option<String>,
    pub start_line: usize,
    pub end_line: usize,
    pub kind: SpaceKind,
    pub spaces: Vec<FuncSpace>,
    pub metrics: CodeMetrics,
    pub suppressed: SuppressionScope,
}

Function space data.

Fields

name: Option<String>

The name of a function space.

For the top-level (file-level) FuncSpace, this is the value supplied via Source::name to analyze — typically a file path or other display identifier chosen by the caller. The library no longer derives this from a &Path or applies lossy UTF-8 conversion; callers are expected to pass an already-stringified identifier (or None if they have no meaningful name to attach). The deprecated entry points get_function_spaces / [metrics_with_options] continue to derive a lossy string from the &Path argument for backwards compatibility.

For nested spaces, None means an error occurred in parsing the name of the function space from the AST.

start_line: usize

The first line of a function space

end_line: usize

The last line of a function space

kind: SpaceKind

The space kind

spaces: Vec<FuncSpace>

All subspaces contained in a function space

metrics: CodeMetrics

All metrics of a function space

suppressed: SuppressionScope

In-source suppression markers that apply to this space.

Populated during the spaces pass from comment-embedded directives. Each marker carries a SuppressionScope naming the metrics it silences. The top-level (file-level) FuncSpace aggregates every file-scoped marker; nested function spaces aggregate every function-scoped marker whose comment lies inside their source range. Metric computation itself is unaffected — this field is consumed by downstream threshold-check code (e.g. bca check), which consults a crate::SuppressionPolicy to decide whether to honour the markers or surface every violation regardless.

Defaults to SuppressionScope::default() (an empty Some), so pre-existing code paths that do not honor suppressions see no behaviour change. The field is elided from JSON output when empty so the existing schema is unchanged for files without markers.

Trait Implementations

impl Clone for FuncSpace

fn clone(&self) -> FuncSpace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FuncSpace

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

Formats the value using the given formatter.

impl Serialize for FuncSpace

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

where __S: Serializer,

Serialize this value into the given Serde serializer.