Document

Struct Document 

Source
pub struct Document {
    pub content: String,
    pub path: PathBuf,
    pub lines: Vec<String>,
}
Expand description

Represents a parsed markdown document with position information

Fields§

§content: String

The original markdown content

§path: PathBuf

Path to the source file

§lines: Vec<String>

Lines split for line-based rule processing

Implementations§

Source§

impl Document

Source

pub fn new(content: String, path: PathBuf) -> Result<Self>

Parse a markdown document from content and path

Source

pub fn parse_ast<'a>(&self, arena: &'a Arena<AstNode<'a>>) -> &'a AstNode<'a>

Parse the content into a comrak AST

Source

pub fn parse_ast_with_context<'a>( &self, arena: &'a Arena<AstNode<'a>>, ) -> Result<&'a AstNode<'a>>

Parse AST with error context

Source

pub fn line_number_at_offset(&self, offset: usize) -> usize

Get the line number (1-based) for a given byte offset

Source

pub fn column_number_at_offset(&self, offset: usize) -> usize

Get the column number (1-based) for a given byte offset

Source

pub fn headings<'a>(&self, ast: &'a AstNode<'a>) -> Vec<&'a AstNode<'a>>

Get all heading nodes from the AST

Source

pub fn headings_with_context<'a>( &self, ast: &'a AstNode<'a>, ) -> Result<Vec<&'a AstNode<'a>>>

Get all heading nodes with error context

Source

pub fn code_blocks<'a>(&self, ast: &'a AstNode<'a>) -> Vec<&'a AstNode<'a>>

Get all code block nodes from the AST

Source

pub fn code_blocks_with_context<'a>( &self, ast: &'a AstNode<'a>, ) -> Result<Vec<&'a AstNode<'a>>>

Get all code block nodes with error context

Source

pub fn heading_level<'a>(node: &'a AstNode<'a>) -> Option<u32>

Get the heading level for a heading node

Source

pub fn node_text<'a>(&self, node: &'a AstNode<'a>) -> String

Get the text content of a node

Source

pub fn node_position<'a>(&self, node: &'a AstNode<'a>) -> Option<(usize, usize)>

Get the source position of a node

Trait Implementations§

Source§

impl Debug for Document

Source§

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

Formats the value using the given formatter. Read more

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