Struct Document 

pub struct Document {
    pub blocks: Vec<Block>,
}

Root of a Markdown document

Fields

blocks: Vec<Block>

Top‑level block sequence in document order.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Document

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl ExpandWith for Document

fn expand_with<T: Transformer>(self, transformer: &mut T) -> Vec<Self>

Apply an expandable transformer to this AST node, returning multiple nodes

impl FilterTransform for Document

fn remove_empty_paragraphs(self) -> Self

Remove empty paragraphs

fn remove_empty_text(self) -> Self

Remove empty text elements

fn normalize_whitespace(self) -> Self

Normalize whitespace in text elements

fn filter_blocks<F>(self, predicate: F) -> Self

where F: Fn(&Block) -> bool,

Remove specific block types

impl PartialEq for Document

fn eq(&self, other: &Document) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PipeExt for Document

fn pipe<F, R>(self, f: F) -> R

where F: FnOnce(Self) -> R, Self: Sized,

Apply a function to self (functional pipe operator)

impl Query for Document

fn find_all_inlines<F>(&self, predicate: F) -> Vec<&Inline>

where F: Fn(&Inline) -> bool,

Find all inline elements matching a predicate

fn find_all_blocks<F>(&self, predicate: F) -> Vec<&Block>

where F: Fn(&Block) -> bool,

Find all block elements matching a predicate

fn find_first_inline<F>(&self, predicate: F) -> Option<&Inline>

where F: Fn(&Inline) -> bool,

Find the first inline element matching a predicate

fn find_first_block<F>(&self, predicate: F) -> Option<&Block>

where F: Fn(&Block) -> bool,

Find the first block element matching a predicate

fn count_inlines<F>(&self, predicate: F) -> usize

where F: Fn(&Inline) -> bool,

Count inline elements matching a predicate

fn count_blocks<F>(&self, predicate: F) -> usize

where F: Fn(&Block) -> bool,

Count block elements matching a predicate

fn any_inline<F>(&self, predicate: F) -> bool

where F: Fn(&Inline) -> bool,

Check if any inline element matches a predicate

fn any_block<F>(&self, predicate: F) -> bool

where F: Fn(&Block) -> bool,

Check if any block element matches a predicate

fn find_all_links(&self) -> Vec<&Link>

Find all links in the document

fn find_all_images(&self) -> Vec<&Image>

Find all images in the document

fn find_all_headings(&self) -> Vec<&Heading>

Find all headings in the document

fn find_all_autolinks(&self) -> Vec<&str>

Find all autolinks in the document

fn find_all_text(&self) -> Vec<&str>

Find all text nodes in the document

fn find_all_code_spans(&self) -> Vec<&str>

Find all code spans in the document

fn find_all_code_blocks(&self) -> Vec<&CodeBlock>

Find all code blocks in the document

fn find_all_tables(&self) -> Vec<&Table>

Find all tables in the document

fn find_all_lists(&self) -> Vec<&List>

Find all lists in the document

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Transform for Document

fn transform_text<F>(self, f: F) -> Self

where F: Fn(String) -> String,

Transform all text elements with a function

fn transform_image_urls<F>(self, f: F) -> Self

where F: Fn(String) -> String,

Transform all image URLs with a function

fn transform_link_urls<F>(self, f: F) -> Self

where F: Fn(String) -> String,

Transform all link URLs with a function

fn transform_autolink_urls<F>(self, f: F) -> Self

where F: Fn(String) -> String,

Transform all autolink URLs with a function

fn transform_code<F>(self, f: F) -> Self

where F: Fn(String) -> String,

Transform all code spans with a function

fn transform_html<F>(self, f: F) -> Self

where F: Fn(String) -> String,

Transform all HTML content with a function

fn transform_with<T: Transformer>(self, transformer: T) -> Self

Apply a custom transformer

fn transform_if_doc<P, F>(self, predicate: P, transform: F) -> Self

where P: Fn(&Self) -> bool, F: FnOnce(Self) -> Self,

Transform conditionally based on a document predicate

impl TransformWith for Document

fn transform_with<T: Transformer>(self, transformer: &mut T) -> Self

Apply a transformer to this AST node

impl VisitWith for Document

fn visit_with<V: Visitor>(&self, visitor: &mut V)

Apply a visitor to this AST node

impl<T: Default> WithData<T> for Document

type WithDataType = Document<T>

The type with user data attached

fn with_data(self, data: T) -> Self::WithDataType

Add user data to this AST node

fn with_default_data(self) -> Self::WithDataType

where T: Default,

Add default user data to this AST node

impl StructuralPartialEq for Document