Struct ConversionOptions 

pub struct ConversionOptions {

    pub heading_style: HeadingStyle,
    pub list_indent_type: ListIndentType,
    pub list_indent_width: usize,
    pub bullets: String,
    pub strong_em_symbol: char,
    pub escape_asterisks: bool,
    pub escape_underscores: bool,
    pub escape_misc: bool,
    pub escape_ascii: bool,
    pub code_language: String,
    pub autolinks: bool,
    pub default_title: bool,
    pub br_in_tables: bool,
    pub hocr_spatial_tables: bool,
    pub highlight_style: HighlightStyle,
    pub extract_metadata: bool,
    pub whitespace_mode: WhitespaceMode,
    pub strip_newlines: bool,
    pub wrap: bool,
    pub wrap_width: usize,
    pub convert_as_inline: bool,
    pub sub_symbol: String,
    pub sup_symbol: String,
    pub newline_style: NewlineStyle,
    pub code_block_style: CodeBlockStyle,
    pub keep_inline_images_in: Vec<String>,
    pub preprocessing: PreprocessingOptions,
    pub encoding: String,
    pub debug: bool,
    pub strip_tags: Vec<String>,
    pub preserve_tags: Vec<String>,
    pub skip_images: bool,
}

Main conversion options for HTML to Markdown conversion.

Fields

heading_style: HeadingStyle

Heading style (Underlined, Atx, AtxClosed)

list_indent_type: ListIndentType

List indentation type (Spaces or Tabs)

list_indent_width: usize

List indentation width in spaces (applied if using spaces indentation)

bullets: String

Bullet characters for unordered lists (e.g., “-”, “*”, “+”)

strong_em_symbol: char

Symbol for strong/emphasis emphasis rendering (* or _)

escape_asterisks: bool

Escape asterisks (*) in text to prevent accidental formatting

escape_underscores: bool

Escape underscores (_) in text to prevent accidental formatting

escape_misc: bool

Escape miscellaneous markdown characters (\ & < ` [ > ~ # = + | -)

escape_ascii: bool

Escape all ASCII punctuation characters (for CommonMark spec compliance tests)

code_language: String

Default code language for fenced code blocks when not specified

autolinks: bool

Use autolinks syntax for bare URLs (http://example.com)

default_title: bool

Add default title element to HTML if none exists before conversion

br_in_tables: bool

Use HTML
elements in tables instead of spaces for line breaks

hocr_spatial_tables: bool

Enable spatial table reconstruction in hOCR documents (via spatial positioning analysis)

highlight_style: HighlightStyle

Highlight style for elements (DoubleEqual, Html, Bold, None)

extract_metadata: bool

Extract metadata from HTML (title, description, images, links, etc.)

whitespace_mode: WhitespaceMode

Whitespace handling mode (Normalized collapses multiple spaces, Strict preserves)

strip_newlines: bool

Strip newline characters from HTML before processing

wrap: bool

Enable automatic text wrapping at wrap_width

wrap_width: usize

Text wrapping width in characters (default 80)

convert_as_inline: bool

Treat block-level elements as inline during conversion

sub_symbol: String

Custom symbol for subscript content (e.g., “~”)

sup_symbol: String

Custom symbol for superscript content (e.g., “^”)

newline_style: NewlineStyle

Newline style in markdown output (Spaces adds two spaces, Backslash adds )

code_block_style: CodeBlockStyle

Code block fence style (Indented, Backticks, Tildes)

keep_inline_images_in: Vec<String>

HTML elements where images should remain as markdown links (not converted to alt text)

preprocessing: PreprocessingOptions

HTML preprocessing options (remove nav, forms, etc.)

encoding: String

Source document encoding (informational, typically “utf-8”)

debug: bool

Enable debug mode with diagnostic warnings on conversion issues

strip_tags: Vec<String>

HTML tags to strip (extract text content, no markdown conversion)

preserve_tags: Vec<String>

HTML tags to preserve as-is in output (keep original HTML, useful for complex tables)

skip_images: bool

Skip all images during conversion. When enabled, all <img> elements are completely omitted from output. Useful for text-only extraction or filtering out visual content.

Implementations

impl ConversionOptions

pub fn apply_update(&mut self, update: ConversionOptionsUpdate)

Apply a partial update to these conversion options.

Any specified fields in the update will override the current values. Unspecified fields (None) are left unchanged.

Arguments

• update - Partial options update with fields to override

pub fn from_update(update: ConversionOptionsUpdate) -> Self

Create new conversion options from a partial update.

Creates a new ConversionOptions struct with defaults, then applies the update. Fields not specified in the update keep their default values.

Arguments

• update - Partial options update with fields to set

Returns

New ConversionOptions with specified updates applied to defaults

Trait Implementations

impl Clone for ConversionOptions

fn clone(&self) -> ConversionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConversionOptions

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

Formats the value using the given formatter.

impl Default for ConversionOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ConversionOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ConversionOptionsUpdate> for ConversionOptions

fn from(update: ConversionOptionsUpdate) -> Self

Converts to this type from the input type.

impl Serialize for ConversionOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.