Skip to main content

ContentBlock

Enum ContentBlock 

Source
pub enum ContentBlock {
    Heading {
        level: usize,
        content: String,
        inline: Vec<InlineElement>,
        anchor: Option<String>,
    },
    Paragraph {
        content: String,
        inline: Vec<InlineElement>,
    },
    Code {
        language: Option<String>,
        content: String,
        start_line: usize,
        end_line: usize,
    },
    List {
        ordered: bool,
        items: Vec<ListItem>,
    },
    Blockquote {
        content: String,
        blocks: Vec<ContentBlock>,
    },
    Table {
        headers: Vec<String>,
        alignments: Vec<TableAlignment>,
        rows: Vec<Vec<String>>,
    },
    Image {
        alt: String,
        src: String,
        title: Option<String>,
    },
    HorizontalRule,
    Details {
        summary: String,
        content: String,
        blocks: Vec<ContentBlock>,
    },
}
Expand description

A parsed content block in a markdown document.

These represent the block-level structure of markdown content, similar to an AST but optimized for consumption by tools like treemd.

Variants§

§

Heading

A heading (# H1, ## H2, etc.)

Fields

§level: usize

Heading level, 1 to 6.

§content: String

The heading’s markdown, without the # markers.

§inline: Vec<InlineElement>

Its inline elements, parsed.

§anchor: Option<String>

The slug a link to the heading uses, if it has text.

§

Paragraph

A paragraph of text

Fields

§content: String

The paragraph’s markdown.

§inline: Vec<InlineElement>

Its inline elements, parsed.

§

Code

A fenced or indented code block

Fields

§language: Option<String>

The fence’s language, if it names one.

§content: String

The code, without the fences.

§start_line: usize

Line the block starts on.

§end_line: usize

Line the block ends on.

§

List

An ordered or unordered list

Fields

§ordered: bool

Whether it’s numbered.

§items: Vec<ListItem>

Its items, in order.

§

Blockquote

A blockquote (> text)

Fields

§content: String

The quote’s markdown, without the > markers.

§blocks: Vec<ContentBlock>

The blocks inside the quote.

§

Table

A table with headers and rows

Fields

§headers: Vec<String>

The header cells.

§alignments: Vec<TableAlignment>

Each column’s alignment.

§rows: Vec<Vec<String>>

The body rows, each a list of cells.

§

Image

An image (standalone, not inline)

Fields

§alt: String

The image’s alt text.

§src: String

Its source path or URL.

§title: Option<String>

Its title, if it has one.

§

HorizontalRule

A horizontal rule (—, ***, ___)

§

Details

HTML <details><summary> block

Fields

§summary: String

The <summary> text.

§content: String

The markdown inside the block.

§blocks: Vec<ContentBlock>

The blocks inside it, parsed.

Implementations§

Source§

impl ContentBlock

Source

pub fn to_plain_text(&self) -> String

Extract plain text from this content block.

Returns only the visible text content, stripping markdown syntax. This is useful for search indexing, accessibility, and accurate word counts.

§Example
use turbovault_core::{ContentBlock, InlineElement};

let block = ContentBlock::Paragraph {
    content: "[Overview](#overview) and **bold**".to_string(),
    inline: vec![
        InlineElement::Link {
            text: "Overview".to_string(),
            url: "#overview".to_string(),
            title: None,
            line_offset: None,
        },
        InlineElement::Text { value: " and ".to_string() },
        InlineElement::Strong { value: "bold".to_string() },
    ],
};
assert_eq!(block.to_plain_text(), "Overview and bold");

Trait Implementations§

Source§

impl Clone for ContentBlock

Source§

fn clone(&self) -> ContentBlock

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
Source§

impl Debug for ContentBlock

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ContentBlock

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ContentBlock

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ContentBlock

Source§

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. Read more
Source§

impl StructuralPartialEq for ContentBlock

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> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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