Struct FormatConfig 

pub struct FormatConfig {

    pub format: Format,
    pub max_width: usize,
    pub use_neural: bool,
    pub neural_lang: String,
    pub neural_model_path: Option<PathBuf>,
    pub extra_abbreviations: Vec<String>,
    pub use_pandoc: bool,
    pub pandoc_format: Option<String>,
    pub pandoc_backend: PandocBackend,
    pub code: HashMap<String, CodeLang>,
    pub format_code: bool,
    pub clause_breaks: bool,
    pub fixpoint_backstop: bool,
    pub render_backstop: bool,
    pub latex_verbatim_envs: Vec<String>,
    pub latex_structure_envs: Vec<String>,
    pub latex_verbatim_commands: Vec<String>,
}

Configuration for the formatting pipeline.

Fields

format: Format

max_width: usize

use_neural: bool

neural_lang: String

neural_model_path: Option<PathBuf>

extra_abbreviations: Vec<String>

use_pandoc: bool

pandoc_format: Option<String>

Pandoc input format string (for pandoc backend).

pandoc_backend: PandocBackend

How to obtain the pandoc AST when use_pandoc is set. Ffi uses in-process Haskell/C bindings; Cli uses a subprocess.

code: HashMap<String, CodeLang>

Per-language code-block configuration loaded from [code] in .snapperrc.toml. Empty by default; an empty map disables all per-language code-block behaviour (block passes through untouched).

format_code: bool

When true, the reflow stage invokes each language’s formatter after comment reflow. Default false preserves v0.7.7 behaviour (no subprocess is spawned).

clause_breaks: bool

Prefer soft breaks after independent-clause punctuation (sembr rule 5). When max_width is 0, every such mark that is already followed by whitespace starts a new line. When max_width is greater than 0, overflowing sentences prefer those marks. Default false keeps one sentence per line (greedy wrap only under max_width).

fixpoint_backstop: bool

Run format_text to a byte fixpoint (cap 4). Production default true; tests set false so a planner that needs the backstop fails.

render_backstop: bool

After the fixpoint, a format-local oracle mismatch returns the original document. Production default true; tests set false and assert the oracle themselves.

latex_verbatim_envs: Vec<String>

Extra LaTeX environments treated as code (no reflow), added to minted/lstlisting/verbatim. Empty keeps the built-in list.

latex_structure_envs: Vec<String>

Extra LaTeX environments treated as structure (no reflow), added to NON_PROSE_ENVS. Empty keeps the built-in list.

latex_verbatim_commands: Vec<String>

Extra LaTeX command names tokenized like \verb before split. Empty keeps verb/lstinline.

Implementations

impl FormatConfig

pub fn without_safety_backstops(self) -> Self

Tests that assert planner properties (idempotence, oracle, splice) must disable both backstops so a planner that needs them fails.

Trait Implementations

impl Default for FormatConfig

fn default() -> Self

Returns the “default value” for a type.