Skip to main content

Options

Struct Options 

Source
pub struct Options {
Show 18 fields pub bullet: char, pub bullet_ordered: char, pub bullet_other: char, pub close_atx: bool, pub emphasis: char, pub fence: char, pub fences: bool, pub increment_list_marker: bool, pub list_item_indent: IndentOptions, pub quote: char, pub resource_link: bool, pub rule: char, pub rule_repetition: u32, pub rule_spaces: bool, pub setext: bool, pub single_dollar_text_math: bool, pub strong: char, pub tight_definitions: bool,
}
Expand description

Configuration.

Fields§

§bullet: char

Marker to use for bullets of items in unordered lists ('*', '+', or '-', default: '*').

§bullet_ordered: char

Marker to use for bullets of items in ordered lists ('.' or ')', default: '.').

§bullet_other: char

Marker to use in certain cases where the primary bullet doesn’t work ('*', '+', or '-', default: '-' when bullet is '*', '*' otherwise).

§close_atx: bool

Whether to add the same number of number signs (#) at the end of an ATX heading as the opening sequence (bool, default: false).

§emphasis: char

Marker to use for emphasis ('*' or '_', default: '*').

§fence: char

Marker to use for fenced code ('`' or '~', default: '`').

§fences: bool

Whether to use fenced code always (bool, default: true). The default is to use fenced code if there is a language defined, if the code is empty, or if it starts or ends in blank lines.

§increment_list_marker: bool

Whether to increment the counter of ordered lists items (bool, default: true).

§list_item_indent: IndentOptions

How to indent the content of list items (default: IndentOptions::One).

§quote: char

Marker to use for titles ('"' or "'", default: '"').

§resource_link: bool

Whether to always use resource links (bool, default: false). The default is to use autolinks (<https://example.com>) when possible and resource links ([text](url)) otherwise.

§rule: char

Marker to use for thematic breaks ('*', '-', or '_', default: '*').

§rule_repetition: u32

Number of markers to use for thematic breaks (u32, default: 3, min: 3).

§rule_spaces: bool

Whether to add spaces between markers in thematic breaks (bool, default: false).

§setext: bool

Whether to use setext headings when possible (bool, default: false). The default is to always use ATX headings (# heading) instead of setext headings (heading\n=======). Setext headings cannot be used for empty headings or headings with a rank of three or more.

§single_dollar_text_math: bool

Whether to support math (text) with a single dollar (bool, default: true). Single dollars work in Pandoc and many other places, but often interfere with “normal” dollars in text. If you turn this off, you can still use two or more dollars for text math.

§strong: char

Marker to use for strong ('*' or '_', default: '*').

§tight_definitions: bool

Whether to join definitions without a blank line (bool, default: false).

Trait Implementations§

Source§

impl Clone for Options

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Options

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Options

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.