Struct MdWriterOptions 

pub struct MdWriterOptions {
    pub link_reference_placement: ReferencePlacement,
    pub footnote_reference_placement: ReferencePlacement,
    pub inline_options: InlineElemOptions,
    pub include_thematic_breaks: bool,
    pub text_width: Option<usize>,
}

Fields

link_reference_placement: ReferencePlacement

Where to put link references (for non-inline links).

footnote_reference_placement: ReferencePlacement

Where to put footnote references.

inline_options: InlineElemOptions

Inline Markdown options.

include_thematic_breaks: bool

Whether to include thematic breaks between top-level elements.

If true, each top-level element will be separated by a thematic break:

   -----

Note that “top-level” refers to the nodes you pass into MdWriter::write, not to what might otherwise look “top level” to a user. For example, if you were to construct an MdElem::Section with depth 2, and within its body another Section with depth 1, only the outer depth-2 Section would count as top-level for these breaks.

text_width: Option<usize>

Optional text wrapping.

Code blocks will never wrap, and certain inline elements (like URLs) will be treated as atomic: if any part of them wraps, the whole thing will wrap, and if it starts a line then it will never wrap.

For example:

┌────────────────────────────────┐
│This is a long line that will   │
│wrap. But                       │
│[this](https://example.com/will/not/wrap)
|because it's a URL.             │
└────────────────────────────────┘

Trait Implementations

impl Clone for MdWriterOptions

fn clone(&self) -> MdWriterOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MdWriterOptions

impl Debug for MdWriterOptions

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

Formats the value using the given formatter.

impl Default for MdWriterOptions

fn default() -> MdWriterOptions

Returns the “default value” for a type.

impl Eq for MdWriterOptions

impl From<&RunOptions> for MdWriterOptions

fn from(cli: &RunOptions) -> Self

Converts to this type from the input type.

impl Hash for MdWriterOptions

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MdWriterOptions

fn cmp(&self, other: &MdWriterOptions) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MdWriterOptions

fn eq(&self, other: &MdWriterOptions) -> 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 PartialOrd for MdWriterOptions

fn partial_cmp(&self, other: &MdWriterOptions) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for MdWriterOptions