Struct AtlasMapConfig

Source

pub(crate) struct AtlasMapConfig {Show 24 fields
    pub(crate) root: PathBuf,
    pub(crate) map_path: PathBuf,
    pub(crate) nonsource_files_path: PathBuf,
    purpose_filename: String,
    source_extensions: BTreeSet<String>,
    exclude_dir_names: BTreeSet<String>,
    exclude_dir_suffixes: BTreeSet<String>,
    exclude_path_prefixes: BTreeSet<String>,
    non_source_path_prefixes: BTreeSet<String>,
    language_overrides: BTreeMap<String, String>,
    allowed_untracked_filenames: BTreeSet<String>,
    untracked_allowlist_dir_prefixes: BTreeSet<String>,
    untracked_allowlist_files: BTreeSet<String>,
    asset_allowed_prefixes: BTreeSet<String>,
    asset_extensions: BTreeSet<String>,
    db_path: PathBuf,
    max_scan_lines: usize,
    text_index_max_bytes: u64,
    summary_max_length: usize,
    summary_ascii_only: bool,
    summary_no_commas: bool,
    purpose_styles: BTreeMap<String, String>,
    purpose_default_style: String,
    line_comment_prefixes: Vec<String>,
}

Expand description

Normalized atlas map configuration.

Fields§

§root: PathBuf

Repository root.

§map_path: PathBuf

Generated TOON map path.

§nonsource_files_path: PathBuf

Non-source file summary path.

§purpose_filename: String

Purpose filename.

§source_extensions: BTreeSet<String>

Source extensions that require purpose headers.

§exclude_dir_names: BTreeSet<String>

Excluded directory names.

§exclude_dir_suffixes: BTreeSet<String>

Excluded directory suffixes.

§exclude_path_prefixes: BTreeSet<String>

Excluded repository-relative prefixes.

§non_source_path_prefixes: BTreeSet<String>

Prefixes treated as non-source even when extensions match.

§language_overrides: BTreeMap<String, String>

Validated exact-filename or extension language overrides.

§allowed_untracked_filenames: BTreeSet<String>

Allowed untracked filenames.

§untracked_allowlist_dir_prefixes: BTreeSet<String>

Allowed untracked directory prefixes.

§untracked_allowlist_files: BTreeSet<String>

Allowed untracked files.

§asset_allowed_prefixes: BTreeSet<String>

Allowed asset root prefixes.

§asset_extensions: BTreeSet<String>

Asset extensions.

§db_path: PathBuf

Durable SQLite index path.

§max_scan_lines: usize

Maximum lines to scan for purpose headers.

§text_index_max_bytes: u64

Maximum UTF-8 file size persisted into SQLite text search.

§summary_max_length: usize

Maximum purpose summary length.

§summary_ascii_only: bool

Whether summaries must be ASCII.

§summary_no_commas: bool

Whether summaries may contain commas.

§purpose_styles: BTreeMap<String, String>

Per-extension purpose styles.

§purpose_default_style: String

Default purpose style.

§line_comment_prefixes: Vec<String>

Supported line-comment prefixes.

Implementations§

Source §

impl AtlasMapConfig

Source

pub(crate) fn with_database_path(self, database_path: &Path) -> Self

Bind database-backed map and lint work to the selected runtime database.

Source

pub(crate) fn scan_options(&self) -> ScanOptions

Return scanner options derived from the normalized project config.

Source

pub(crate) fn text_index_max_bytes(&self) -> u64

Return the configured maximum UTF-8 file size for SQLite text search.

Source

pub(crate) fn purpose_filename(&self) -> &str

Return the configured legacy folder-purpose filename.

Trait Implementations§

Source §

impl Clone for AtlasMapConfig

Source §

fn clone(&self) -> AtlasMapConfig

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for AtlasMapConfig

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for AtlasMapConfig

Blanket Implementations§

Source §

impl<T> Any for T
where T: 'static + ?Sized,

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

impl<T> Borrow<T> for T
where T: ?Sized,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source §

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> DynClone for T
where T: Clone,

Source §

fn __clone_box(&self, _: Private) -> *mut ()

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Source §

impl<T, U> Into for T
where U: From<T>,

Source §

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

§