Options

Struct Options 

Source
pub struct Options {
    pub clean_indentations: bool,
    pub continue_inline_code: bool,
    pub continue_italic: bool,
    pub continue_bold: bool,
    pub continue_strikeout: bool,
    pub keep_code_fences: bool,
}
Expand description

Markdown parsing options

Fields§

§clean_indentations: bool

Remove one or several superfluous levels of indentations

This is useful when your text is too deeply intended, for example because it’s defined in a raw literal:

use minimad::*;
let text = r#"
    bla bla bla
    * item 1
    * item 2
"#;
assert_eq!(
    parse_text(text, Options { clean_indentations: true, ..Default::default() }),
    Text { lines: vec![
        Line::from("bla bla bla"),
        Line::from("* item 1"),
        Line::from("* item 2"),
    ]},
);
§continue_inline_code: bool§continue_italic: bool§continue_bold: bool§continue_strikeout: bool§keep_code_fences: bool

Implementations§

Source§

impl Options

Source

pub fn clean_indentations(self, value: bool) -> Self

Source

pub fn continue_inline_code(self, value: bool) -> Self

Source

pub fn continue_italic(self, value: bool) -> Self

Source

pub fn continue_bold(self, value: bool) -> Self

Source

pub fn continue_strikeout(self, value: bool) -> Self

Source

pub fn continue_spans(self, value: bool) -> Self

Source

pub fn keep_code_fences(self, value: bool) -> Self

Trait Implementations§

Source§

impl Clone for Options

Source§

fn clone(&self) -> Options

Returns a duplicate 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 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
Source§

impl Copy for Options

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 = 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.