Struct FmtOptions 

pub struct FmtOptions { /* private fields */ }

Formatter knobs.

Style knobs default to Preserve except GFM tables, which default to compact normal form. The structural-emit pipeline never consults style knobs; rewrites are applied by the formatter’s rewrite-family pipeline. Structural defaults: wrap = keep, trailing-newline = preserve, end-of-line = lf, empty exclude list.

Implementations

impl FmtOptions

pub fn wrap(&self) -> Wrap

Wrap mode for prose paragraphs.

pub fn wrap_strategy(&self) -> WrapStrategy

Paragraph wrap strategy.

pub fn italic(&self) -> ItalicStyle

Italic delimiter normalisation policy.

pub fn strong(&self) -> StrongStyle

Strong-emphasis delimiter normalisation policy.

pub fn list_marker(&self) -> ListMarkerStyle

Unordered-list bullet normalisation policy.

pub fn list_continuation_indent(&self) -> ListContinuationIndent

List continuation indentation used when wrapping list-item paragraphs.

pub fn ordered_list(&self) -> OrderedListStyle

Ordered-list number normalisation policy.

pub fn table(&self) -> TableStyle

GFM table canonicalisation policy.

pub fn trailing_newline(&self) -> TrailingNewline

Trailing-newline policy at the document boundary.

pub fn end_of_line(&self) -> EndOfLine

Line-ending normalisation policy.

pub fn exclude_globs(&self) -> &[String]

Formatter-specific exclude globs (independent of [lint] exclude).

pub fn link_def_placement(&self) -> Placement

Where reference-link definitions are emitted: gathered + sorted at end of document, or kept in source positions.

pub fn link_def_style(&self) -> LinkDefStyle

Whether reference-link and inline-link destinations are emitted bare or angle-bracketed.

pub fn footnote_placement(&self) -> Placement

Where footnote definitions are emitted. Populated for parity with Self::link_def_placement; session 11 reads this.

pub fn preserve_frontmatter(&self) -> bool

Whether to emit the document’s frontmatter byte-verbatim in the formatted output. true (the default) preserves YAML or TOML frontmatter exactly; false strips it.

pub fn thematic_break_style(&self) -> ThematicStyle

Thematic-break canonicalisation policy. Defaults to ThematicStyle::Preserve. The structural-emit path does not consult this; a later canonicalisation post-pass will.

pub fn math(&self) -> MathOptions

Math canonicalisation configuration. See MathOptions for the reason every field defaults off.

pub fn with_math(self, math: MathOptions) -> Self

Override the math options. Returns the receiver for chaining.

pub fn with_math_render(self, render: MathRender) -> Self

Override only the math render policy. Composes with the existing MathOptions; preserves normalise.

pub fn heading_attrs(&self) -> HeadingAttrsStyle

Heading-attribute trailer emission policy.

pub fn with_heading_attrs(self, style: HeadingAttrsStyle) -> Self

Override the heading-attribute style.

pub fn resolve_italic(&self, source_delim: u8) -> u8

Resolve the italic delimiter to emit, given the byte the source originally used (b'*' or b'_'). Preserve returns source_delim; fixed styles return their own byte. Keeps the match out of every render site.

pub fn with_wrap(self, wrap: Wrap) -> Self

Override the wrap mode. Returns the receiver for chaining. Used by callers that build FmtOptions programmatically (benches, golden tests, --wrap overrides).

pub fn with_wrap_strategy(self, strategy: WrapStrategy) -> Self

Override the paragraph wrap strategy.

pub fn with_italic(self, italic: ItalicStyle) -> Self

Override the italic style. Used by callers that build options programmatically (property tests, CLI overrides).

pub fn with_strong(self, strong: StrongStyle) -> Self

Override the strong style.

pub fn with_list_marker(self, list_marker: ListMarkerStyle) -> Self

Override the unordered-list bullet style.

pub fn with_list_continuation_indent( self, indent: ListContinuationIndent, ) -> Self

Override list continuation indentation for wrapped list items.

pub fn with_ordered_list(self, ordered_list: OrderedListStyle) -> Self

Override the ordered-list numbering policy.

pub fn with_table(self, table: TableStyle) -> Self

Override the GFM table canonicalisation policy.

pub fn with_thematic_break(self, thematic_break: ThematicStyle) -> Self

Override the thematic-break canonicalisation policy.

pub fn with_link_def_style(self, link_def_style: LinkDefStyle) -> Self

Override the link-destination style.

pub fn resolve_list_marker(&self, source_marker: u8) -> u8

Resolve the unordered-list bullet to emit, given the byte the source used (b'-', b'*', or b'+').

pub fn with_trailing_newline(self, trailing_newline: TrailingNewline) -> Self

Override the trailing-newline policy.

pub fn with_end_of_line(self, end_of_line: EndOfLine) -> Self

Override the end-of-line policy.

pub fn with_exclude_globs(self, exclude_globs: Vec<String>) -> Self

Override formatter exclude globs.

pub fn with_link_def_placement(self, placement: Placement) -> Self

Override reference-definition placement.

pub fn with_footnote_placement(self, placement: Placement) -> Self

Override footnote-definition placement.

pub fn with_preserve_frontmatter(self, preserve_frontmatter: bool) -> Self

Override frontmatter preservation.

impl FmtOptions

pub fn mdformat() -> Self

mdformat-compatible formatting profile where mdwright can reproduce mdformat’s spelling without weakening verification.

mdformat 1.0 defaults to wrap = keep; callers that want a column limit should still set Self::with_wrap explicitly.

Trait Implementations

impl Clone for FmtOptions

fn clone(&self) -> FmtOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FmtOptions

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

Formats the value using the given formatter.

impl Default for FmtOptions

fn default() -> Self

Returns the “default value” for a type.