Struct MarkdownDocument 

pub struct MarkdownDocument { /* private fields */ }

A parsed Markdown document.

Implementations

impl MarkdownDocument

pub fn anchor_for_target(&self, id: MarkdownTargetId) -> Option<MarkdownAnchor>

Creates a durable anchor for a document-local target.

pub fn resolve_anchor( &self, anchor: &MarkdownAnchor, ) -> Option<MarkdownTargetId>

Resolves a durable anchor to a target in this document.

pub fn rendered_target_text(&self, id: MarkdownTargetId) -> Option<String>

Returns the style-free rendered text for a target.

impl MarkdownDocument

pub fn new(source: impl Into<String>) -> MarkdownDocument

Creates a document by parsing Markdown with the supported GFM extensions enabled.

pub fn empty() -> MarkdownDocument

Returns an empty Markdown document.

pub fn parse(source: impl Into<String>) -> MarkdownDocument

Parses Markdown with the supported GFM extensions enabled.

pub fn from_source(source: impl Into<String>) -> MarkdownDocument

Alias for Self::parse that makes the source-oriented API explicit.

pub fn parse_with_metadata( source_path: Option<String>, title: Option<String>, source: impl Into<String>, ) -> MarkdownDocument

Parses Markdown while retaining optional host-provided metadata.

pub fn source_styles(&self) -> &[MarkdownSourceStyle]

pub fn source(&self) -> &str

Returns the original source, including its original line endings.

pub fn source_path(&self) -> Option<&str>

Returns the optional source path supplied by the host.

pub fn title(&self) -> Option<&str>

Returns the optional display title supplied by the host.

pub fn blocks(&self) -> &[MarkdownBlock]

Returns the top-level semantic blocks.

pub fn outline(&self) -> &[MarkdownHeading]

Returns headings in document order.

pub fn targets(&self) -> &[MarkdownTarget]

Returns all commentable targets in document order.

pub fn target(&self, id: MarkdownTargetId) -> Option<&MarkdownTarget>

Finds a target by its document-local ID.

pub fn code_blocks(&self) -> Vec<&MarkdownCodeBlock>

Trait Implementations

impl Clone for MarkdownDocument

fn clone(&self) -> MarkdownDocument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MarkdownDocument

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

Formats the value using the given formatter.

impl Default for MarkdownDocument

fn default() -> MarkdownDocument

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MarkdownDocument

fn deserialize<__D>( __deserializer: __D, ) -> Result<MarkdownDocument, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MarkdownDocument

impl PartialEq for MarkdownDocument

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MarkdownDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MarkdownDocument