Struct MetricsCfg 

#[non_exhaustive]
pub struct MetricsCfg {
    pub path: PathBuf,
    pub options: MetricsOptions,
}

Configuration options for computing the metrics of a code.

Marked #[non_exhaustive] so future config fields can land additively. Downstream callers must construct via the builder methods rather than struct-literal syntax (rustc rejects external struct literals on non-exhaustive types with E0639, including the ..Default::default() spread form).

use std::path::PathBuf;
use big_code_analysis::{MetricsCfg, MetricsOptions};

let cfg = MetricsCfg::new(PathBuf::from("lib.rs"))
    .with_options(MetricsOptions::default().with_exclude_tests(true));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: PathBuf

Path to the file containing the code

options: MetricsOptions

Per-traversal options forwarded to [metrics_with_options].

Implementations

impl MetricsCfg

pub fn new(path: PathBuf) -> Self

Build a MetricsCfg for path with default options. Chain MetricsCfg::with_options to override the per-traversal flags. Required because MetricsCfg is #[non_exhaustive] — downstream crates cannot use the struct-literal form.

pub fn with_options(self, options: MetricsOptions) -> Self

Builder-style setter for MetricsCfg::options.

Trait Implementations

impl Debug for MetricsCfg

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

Formats the value using the given formatter.

impl Default for MetricsCfg

fn default() -> MetricsCfg

Returns the “default value” for a type.