Struct pulldown_cmark_to_cmark::State

pub struct State<'a> {
    pub newlines_before_start: usize,
    pub list_stack: Vec<Option<u64>>,
    pub padding: Vec<Cow<'a, str>>,
    pub table_alignments: Vec<Alignment>,
    pub table_headers: Vec<String>,
    pub store_next_text: bool,
    pub text_for_header: Option<String>,
    pub is_in_code_block: bool,
    pub last_was_html: bool,
}

The state of the cmark function. This does not only allow introspection, but enables the user to halt the serialization at any time, and resume it later.

Fields

newlines_before_start: usize

The amount of newlines to insert after Event::Start(...)

list_stack: Vec<Option<u64>>

The lists and their types for which we have seen a Event::Start(List(...)) tag

padding: Vec<Cow<'a, str>>

The computed padding and prefix to print after each newline. This changes with the level of BlockQuote and List events.

table_alignments: Vec<Alignment>

Keeps the current table alignments, if we are currently serializing a table.

table_headers: Vec<String>

Keeps the current table headers, if we are currently serializing a table.

store_next_text: bool

If set, the next 'text' will be stored for later use

text_for_header: Option<String>

The last seen text when serializing a header

is_in_code_block: bool

Is set while we are handling text in a code block

last_was_html: bool

True if the last event was html. Used to inject additional newlines to support markdown inside of HTML tags.

Trait Implementations

impl<'a> Clone for State<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for State<'a>

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

Formats the value using the given formatter.

impl<'a> Default for State<'a>

fn default() -> State<'a>

Returns the "default value" for a type.

impl<'a> Eq for State<'a>

impl<'a> Hash for State<'a>

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, 

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for State<'a>

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'a> PartialEq<State<'a>> for State<'a>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &State<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<State<'a>> for State<'a>

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

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

fn lt(&self, other: &State<'a>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &State<'a>) -> bool

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

fn gt(&self, other: &State<'a>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &State<'a>) -> bool

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

impl<'a> StructuralEq for State<'a>

impl<'a> StructuralPartialEq for State<'a>