Skip to main content

MarkdownDoc

ailint_core::parser::markdown

Struct MarkdownDoc

pub struct MarkdownDoc {
    pub frontmatter: Option<Frontmatter>,
    pub headings: Vec<Heading>,
    pub sections: Vec<Section>,
    pub code_blocks: Vec<CodeBlock>,
    pub list_items: Vec<ListItem>,
    pub paragraphs: Vec<Paragraph>,
    pub links: Vec<Link>,
}

Expand description

Structural index of a Markdown document, built in one parse pass.

Fields§

§frontmatter: Option<Frontmatter>

YAML frontmatter block, if the file starts with ---.

§headings: Vec<Heading>

All headings, in document order.

§sections: Vec<Section>

Heading-delimited spans covering the whole body.

§code_blocks: Vec<CodeBlock>

Fenced and indented code blocks.

§list_items: Vec<ListItem>

Bullet and ordered list items, flattened.

§paragraphs: Vec<Paragraph>

Top-level prose paragraphs (excludes headings, list items, code blocks).

§links: Vec<Link>

All hyperlinks.

Trait Implementations§

impl Clone for MarkdownDoc

fn clone(&self) -> MarkdownDoc

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Debug for MarkdownDoc

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

Formats the value using the given formatter. Read more

impl Default for MarkdownDoc

fn default() -> MarkdownDoc

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

Auto Trait Implementations§

impl Freeze for MarkdownDoc

impl RefUnwindSafe for MarkdownDoc

impl Send for MarkdownDoc

impl Sync for MarkdownDoc

impl Unpin for MarkdownDoc

impl UnsafeUnpin for MarkdownDoc

impl UnwindSafe for MarkdownDoc

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

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

Performs copy-assignment from self to dest. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more