Struct Options 

#[non_exhaustive]
pub struct Options { /* private fields */ }

Configuration options for the converter.

Use Default::default() for sensible CommonMark defaults, then override individual fields with the provided setter methods:

use h2m::Options;

let opts = Options::default()
    .with_heading_style(h2m::HeadingStyle::Setext)
    .with_bullet_marker(h2m::BulletMarker::Asterisk);

Implementations

impl Options

pub const fn heading_style(&self) -> HeadingStyle

Returns the heading rendering style.

pub const fn bullet_marker(&self) -> BulletMarker

Returns the bullet character for unordered lists.

pub const fn code_block_style(&self) -> CodeBlockStyle

Returns the code block rendering style.

pub const fn fence(&self) -> Fence

Returns the fence character for fenced code blocks.

pub const fn em_delimiter(&self) -> EmDelimiter

Returns the delimiter for emphasis (italic) text.

pub const fn strong_delimiter(&self) -> StrongDelimiter

Returns the delimiter for strong emphasis (bold) text.

pub const fn horizontal_rule(&self) -> HorizontalRule

Returns the horizontal rule style.

pub const fn escape_mode(&self) -> EscapeMode

Returns the escape mode for markdown special characters.

pub const fn link_style(&self) -> LinkStyle

Returns the link rendering style.

pub const fn link_reference_style(&self) -> LinkReferenceStyle

Returns the reference-style link identifier format.

pub const fn with_heading_style(self, style: HeadingStyle) -> Self

Sets the heading rendering style.

pub const fn with_bullet_marker(self, marker: BulletMarker) -> Self

Sets the bullet character for unordered lists.

pub const fn with_code_block_style(self, style: CodeBlockStyle) -> Self

Sets the code block rendering style.

pub const fn with_fence(self, fence: Fence) -> Self

Sets the fence character for fenced code blocks.

pub const fn with_em_delimiter(self, delim: EmDelimiter) -> Self

Sets the delimiter for emphasis (italic) text.

pub const fn with_strong_delimiter(self, delim: StrongDelimiter) -> Self

Sets the delimiter for strong emphasis (bold) text.

pub const fn with_horizontal_rule(self, rule: HorizontalRule) -> Self

Sets the horizontal rule style.

pub const fn with_escape_mode(self, mode: EscapeMode) -> Self

Sets the escape mode for markdown special characters.

pub const fn with_link_style(self, style: LinkStyle) -> Self

Sets the link rendering style.

pub const fn with_link_reference_style(self, style: LinkReferenceStyle) -> Self

Sets the reference-style link identifier format.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Options

impl Eq for Options

impl StructuralPartialEq for Options