Skip to main content

Module prelude

Module prelude 

Source
Expand description

Recommended entry points for the 90% case.

Star-import this module to get the curated set of types and functions most callers need:

use big_code_analysis::prelude::*;

let source = b"fn main() {}";
let space = analyze(
    Source::new(LANG::Rust, source),
    MetricsOptions::default(),
).expect("Rust source parses");

Anything not exposed here can still be imported with its fully-qualified name from the crate root (use big_code_analysis::Something;). Items deliberately omitted from the prelude are either deprecated, doc-hidden, or unlikely to appear in typical caller code.

Re-exports§

pub use crate::Ast;
pub use crate::CodeMetrics;
pub use crate::FromPathError;
pub use crate::FuncSpace;
pub use crate::Metric;
pub use crate::MetricsOptions;
pub use crate::Source;
pub use crate::analyze;

Enums§

LANG
The list of supported languages.
MetricsError
Error returned by the library’s metric-computation entry points.
SpaceKind
The list of supported space kinds.