Struct MarkdownOptions 

#[non_exhaustive]
pub struct MarkdownOptions {
    pub include_headers: bool,
    pub include_footers: bool,
    pub page_separators: PageSeparators,
    pub code: bool,
    pub include_figures: bool,
    pub table_render_mode: TableRenderMode,
}

Which blocks reach the Markdown, and how a change of page is marked.

The switches ExtractOptions carries for PdfDocument::extract_markdown, as the to_markdown_with_*_options functions below take them. Default is today’s output: no furniture, and every page change a comment.

#[non_exhaustive], so a switch added here cannot break a caller that never named it: start from Default and assign the fields you want.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

include_headers: bool

Whether BlockKind::Header blocks are written as plain paragraphs at their reading-order position. Default false: they are left out, exactly as without the option. Never as headings: a running head is not a section title.

include_footers: bool

Whether BlockKind::Footer blocks are written as plain paragraphs at their reading-order position. Default false: they are left out, exactly as without the option. Never as headings either.

page_separators: PageSeparators

How a change of page is marked. Default PageSeparators::Comment: today’s <!-- page N --> marker.

code: bool

Whether monospace runs reach the Markdown as code. Default true: `like this` in a paragraph, a fenced block for a paragraph set wholly in one. False restores the output from before code existed, byte for byte.

include_figures: bool

Whether figures are written as image references. Default true.

False writes no reference at all, the way the furniture reads without its switches.

table_render_mode: TableRenderMode

How tables reach the Markdown. Default TableRenderMode::Auto: pipes where Markdown holds the table’s shape, HTML elsewhere – today’s output, byte for byte.

Trait Implementations

impl Clone for MarkdownOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MarkdownOptions

impl Debug for MarkdownOptions

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

Formats the value using the given formatter.

impl Default for MarkdownOptions

fn default() -> Self

Today’s output: no furniture, every page change a comment, and monospace as code.

impl Eq for MarkdownOptions

impl From<&ExtractOptions> for MarkdownOptions

fn from(options: &ExtractOptions) -> Self

The markdown half of an ExtractOptions: what extract_markdown serializes with.

impl PartialEq for MarkdownOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MarkdownOptions