Struct ScanConfig 

pub struct ScanConfig {
    pub language: Option<String>,
    pub extensions: Vec<String>,
    pub include_patterns: Vec<String>,
    pub exclude_patterns: Vec<String>,
    pub follow_symlinks: bool,
    pub max_depth: Option<usize>,
    pub collect_metadata: bool,
    pub parallel: bool,
    pub disable_default_excludes: bool,
    pub error_handling: ErrorHandling,
    pub no_ignore: bool,
}

Configuration for project scanning.

Fields

language: Option<String>

Filter by specific language (e.g., “python”).

extensions: Vec<String>

Filter by file extensions (e.g., [“.py”, “.pyi”]).

include_patterns: Vec<String>

Glob patterns to include (e.g., [“src/**/*.rs”]).

exclude_patterns: Vec<String>

Glob patterns to exclude (e.g., [“/test/”]).

follow_symlinks: bool

Whether to follow symbolic links (default: false).

max_depth: Option<usize>

Maximum directory depth (None for unlimited).

collect_metadata: bool

Whether to collect file metadata (default: false for faster scanning).

parallel: bool

Whether to use parallel scanning (default: true for large projects).

disable_default_excludes: bool

Whether to disable default exclude patterns (node_modules, pycache, .git, etc.). Default: false (default excludes are applied). Set to true when you need to include files from typically-excluded directories like vendored dependencies in node_modules.

error_handling: ErrorHandling

How to handle errors encountered during scanning. Default: CollectAndContinue (collect errors but don’t stop scanning).

no_ignore: bool

Whether to ignore all ignore files (.gitignore, .brrrignore) and include all files. Default: false (respect ignore files). Set to true to bypass all ignore file processing (equivalent to –no-ignore flag).

Implementations

impl ScanConfig

pub fn for_language(lang: &str) -> Self

Create a config for scanning a specific language.

pub fn for_extensions(exts: &[&str]) -> Self

Create a config for scanning specific file extensions.

pub fn with_includes(self, patterns: &[&str]) -> Self

Add include patterns.

pub fn with_excludes(self, patterns: &[&str]) -> Self

Add exclude patterns.

pub fn with_metadata(self) -> Self

Enable metadata collection.

pub fn with_max_depth(self, depth: usize) -> Self

Set maximum traversal depth.

pub fn with_default_excludes_disabled(self) -> Self

Disable default exclude patterns (node_modules, pycache, .git, etc.).

Use this when you need to include files from typically-excluded directories, such as vendored dependencies in node_modules or build artifacts you want to analyze.

Example

use go_brrr::callgraph::scanner::ScanConfig;

// Include vendored dependencies from node_modules
let config = ScanConfig::default()
    .with_default_excludes_disabled()
    .with_includes(&["**/node_modules/vendor/**"]);

pub fn with_error_handling(self, handling: ErrorHandling) -> Self

Set how errors should be handled during scanning.

Example

use go_brrr::callgraph::scanner::{ScanConfig, ErrorHandling};

// Fail immediately on any error
let strict_config = ScanConfig::default()
    .with_error_handling(ErrorHandling::FailFast);

// Collect errors but continue scanning (default)
let permissive_config = ScanConfig::default()
    .with_error_handling(ErrorHandling::CollectAndContinue);

pub fn fail_on_error(self) -> Self

Configure to fail fast on any error.

Shorthand for .with_error_handling(ErrorHandling::FailFast).

pub fn with_no_ignore(self, no_ignore: bool) -> Self

Set whether to ignore all ignore files (.gitignore, .brrrignore).

When set to true, all files will be included regardless of ignore patterns. This is equivalent to the --no-ignore CLI flag.

Example

use go_brrr::callgraph::scanner::ScanConfig;

// Include all files, ignoring .gitignore and .brrrignore
let config = ScanConfig::default()
    .with_no_ignore(true);

Trait Implementations

impl Clone for ScanConfig

fn clone(&self) -> ScanConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScanConfig

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

Formats the value using the given formatter.

impl Default for ScanConfig

fn default() -> ScanConfig

Returns the “default value” for a type.