Struct pulldown_cmark_to_cmark::Options

source ·
pub struct Options<'a> {
Show 17 fields pub newlines_after_headline: usize, pub newlines_after_paragraph: usize, pub newlines_after_codeblock: usize, pub newlines_after_htmlblock: usize, pub newlines_after_table: usize, pub newlines_after_rule: usize, pub newlines_after_list: usize, pub newlines_after_blockquote: usize, pub newlines_after_rest: usize, pub newlines_after_metadata: usize, pub code_block_token_count: usize, pub code_block_token: char, pub list_token: char, pub ordered_list_token: char, pub increment_ordered_list_bullets: bool, pub emphasis_token: char, pub strong_token: &'a str,
}
Expand description

Configuration for the cmark_with_options() and cmark_resume_with_options() functions. The defaults should provide decent spacing and most importantly, will provide a faithful rendering of your markdown document particularly when rendering it to HTML.

It’s best used with its Options::default() implementation.

Fields§

§newlines_after_headline: usize§newlines_after_paragraph: usize§newlines_after_codeblock: usize§newlines_after_htmlblock: usize§newlines_after_table: usize§newlines_after_rule: usize§newlines_after_list: usize§newlines_after_blockquote: usize§newlines_after_rest: usize§newlines_after_metadata: usize

The amount of newlines placed after TOML or YAML metadata blocks at the beginning of a document.

§code_block_token_count: usize

Token count for fenced code block. An appropriate value of this field can be decided by calculate_code_block_token_count(). Note that the default value is 4 which allows for one level of nested code-blocks, which is typically a safe value for common kinds of markdown documents.

§code_block_token: char§list_token: char§ordered_list_token: char§increment_ordered_list_bullets: bool§emphasis_token: char§strong_token: &'a str

Implementations§

source§

impl<'a> Options<'a>

source

pub fn special_characters(&self) -> Cow<'static, str>

Trait Implementations§

source§

impl<'a> Clone for Options<'a>

source§

fn clone(&self) -> Options<'a>

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl<'a> Debug for Options<'a>

source§

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

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

impl<'a> Default for Options<'a>

source§

fn default() -> Self

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

impl<'a> Hash for Options<'a>

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl<'a> Ord for Options<'a>

source§

fn cmp(&self, other: &Options<'a>) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
source§

impl<'a> PartialEq for Options<'a>

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl<'a> PartialOrd for Options<'a>

source§

fn partial_cmp(&self, other: &Options<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl<'a> Eq for Options<'a>

source§

impl<'a> StructuralPartialEq for Options<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Options<'a>

§

impl<'a> RefUnwindSafe for Options<'a>

§

impl<'a> Send for Options<'a>

§

impl<'a> Sync for Options<'a>

§

impl<'a> Unpin for Options<'a>

§

impl<'a> UnwindSafe for Options<'a>

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.