Skip to main content

Document

Struct Document

pub struct Document {
    pub raw_metadata: Option<String>,
    pub metadata_format: Option<FrontmatterFormat>,
    pub frontmatter: Option<Frontmatter>,
    pub html: String,
    pub headings: Vec<Heading>,
    pub reqs: Vec<ReqDefinition>,
    pub code_samples: Vec<CodeSample>,
    pub elements: Vec<DocElement>,
    pub head_injections: Vec<String>,
    pub inline_code_spans: Vec<InlineCodeSpan>,
}

Expand description

A rendered markdown document.

Fields§

§raw_metadata: Option<String>

Raw metadata content (without delimiters)

§metadata_format: Option<FrontmatterFormat>

Detected metadata format

§frontmatter: Option<Frontmatter>

Parsed frontmatter (if present) - convenience accessor

§html: String

Rendered HTML content

§headings: Vec<Heading>

Extracted headings for TOC generation

§reqs: Vec<ReqDefinition>

Extracted requirement definitions

§code_samples: Vec<CodeSample>

Code samples found in the document

§elements: Vec<DocElement>

All document elements (headings and requirements) in document order. Useful for building hierarchical structures like outlines with coverage.

§head_injections: Vec<String>

HTML snippets to inject into the page’s <head> (or body end). Already deduplicated by key during rendering.

§inline_code_spans: Vec<InlineCodeSpan>

All inline code spans (backtick-delimited) found in the document. Spans include byte offsets covering the backtick delimiters.

Trait Implementations§

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for Document

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Document

impl RefUnwindSafe for Document

impl Send for Document

impl Sync for Document

impl Unpin for Document

impl UnsafeUnpin for Document

impl UnwindSafe for Document

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> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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