Struct ApiSurfaceReport 

pub struct ApiSurfaceReport {
    pub total_items: usize,
    pub public_items: usize,
    pub internal_items: usize,
    pub public_ratio: f64,
    pub documented_ratio: f64,
    pub by_language: BTreeMap<String, LangApiSurface>,
    pub by_module: Vec<ModuleApiRow>,
    pub top_exporters: Vec<ApiExportItem>,
}

Public API surface analysis report.

Computes public export ratios per language and module by scanning source files for exported symbols (pub fn, export function, etc.).

Fields

total_items: usize

Total items discovered across all languages.

public_items: usize

Items with public visibility.

internal_items: usize

Items with internal/private visibility.

public_ratio: f64

Ratio of public to total items (0.0-1.0).

documented_ratio: f64

Ratio of documented public items (0.0-1.0).

by_language: BTreeMap<String, LangApiSurface>

Per-language breakdown.

by_module: Vec<ModuleApiRow>

Per-module breakdown.

top_exporters: Vec<ApiExportItem>

Top exporters (files with most public items).

Trait Implementations

impl Clone for ApiSurfaceReport

fn clone(&self) -> ApiSurfaceReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiSurfaceReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiSurfaceReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiSurfaceReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.