Struct pulldown_cmark_to_cmark::State

source ·
pub struct State<'a> {
Show 15 fields 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 text_for_header: Option<String>, pub is_in_code_block: bool, pub last_was_text_without_trailing_newline: bool, pub last_was_paragraph_start: bool, pub link_stack: Vec<LinkCategory<'a>>, pub image_stack: Vec<ImageLink<'a>>, pub current_heading: Option<Heading<'a>>, pub current_shortcut_text: Option<String>, pub shortcuts: Vec<(String, String, String)>, pub last_event_end_index: usize,
}
Expand description

The state of the cmark_resume() and cmark_resume_with_options() functions. 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.

§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_text_without_trailing_newline: bool

True if the last event was text and the text does not have trailing newline. Used to inject additional newlines before code block end fence.

§last_was_paragraph_start: bool

True if the last event was a paragraph start. Used to escape spaces at start of line (prevent spurrious indented code).

§link_stack: Vec<LinkCategory<'a>>

Currently open links

§image_stack: Vec<ImageLink<'a>>

Currently open images

§current_heading: Option<Heading<'a>>

Keeps track of the last seen heading’s id, classes, and attributes

§current_shortcut_text: Option<String>

Keeps track of the last seen shortcut/link

§shortcuts: Vec<(String, String, String)>

A list of shortcuts seen so far for later emission

§last_event_end_index: usize

Index into the source bytes of the end of the range corresponding to the last event.

It’s used to see if the current event didn’t capture some bytes because of a skipped-over backslash.

Implementations§

source§

impl<'a> State<'a>

source

pub fn finalize<F>(self, formatter: F) -> Result<Self, Error>
where F: Write,

Trait Implementations§

source§

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

source§

fn clone(&self) -> State<'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 State<'a>

source§

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

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

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

source§

fn default() -> State<'a>

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

impl<'a> Hash for State<'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 State<'a>

source§

fn cmp(&self, other: &State<'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 State<'a>

source§

fn eq(&self, other: &State<'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 State<'a>

source§

fn partial_cmp(&self, other: &State<'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 State<'a>

source§

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

Auto Trait Implementations§

§

impl<'a> Freeze for State<'a>

§

impl<'a> RefUnwindSafe for State<'a>

§

impl<'a> Send for State<'a>

§

impl<'a> Sync for State<'a>

§

impl<'a> Unpin for State<'a>

§

impl<'a> UnwindSafe for State<'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.