Skip to main content

DocumentBlock

mcd_core::document

Enum DocumentBlock

pub enum DocumentBlock {
    Heading {
        id: String,
        level: u8,
        text: String,
        source: Option<SourceSpan>,
        annotations: Vec<AnnotationRef>,
    },
    Paragraph {
        id: String,
        text: String,
        source: Option<SourceSpan>,
        annotations: Vec<AnnotationRef>,
    },
    List {
        id: String,
        text: String,
        source: Option<SourceSpan>,
        annotations: Vec<AnnotationRef>,
    },
    CodeBlock {
        id: String,
        language: Option<String>,
        text: String,
        source: Option<SourceSpan>,
        annotations: Vec<AnnotationRef>,
    },
    Quote {
        id: String,
        text: String,
        source: Option<SourceSpan>,
        annotations: Vec<AnnotationRef>,
    },
    MathBlock {
        id: String,
        text: String,
        source: Option<SourceSpan>,
    },
    TableRef {
        id: String,
        placement: TablePlacement,
        source: Option<SourceSpan>,
    },
    ImageRef {
        id: String,
        placement: ImagePlacement,
        source: Option<SourceSpan>,
    },
}

Expand description

A canonical document block.

Variants§

Heading

Markdown heading.

Fields

§id: String

Stable generated block id.

§level: u8

Heading level.

§text: String

Plain heading text.

§source: Option<SourceSpan>

Source span when available.

§annotations: Vec<AnnotationRef>

Inline annotation markers in this block.

Paragraph

Markdown paragraph.

Fields

§id: String

Stable generated block id.

§text: String

Plain paragraph text.

§source: Option<SourceSpan>

Source span when available.

§annotations: Vec<AnnotationRef>

Inline annotation markers in this block.

List

Markdown list.

Fields

§id: String

Stable generated block id.

§text: String

Plain list text.

§source: Option<SourceSpan>

Source span when available.

§annotations: Vec<AnnotationRef>

Inline annotation markers in this block.

CodeBlock

Markdown code block.

Fields

§id: String

Stable generated block id.

§language: Option<String>

Optional language/info string.

§text: String

Literal code text.

§source: Option<SourceSpan>

Source span when available.

§annotations: Vec<AnnotationRef>

Inline annotation markers in this block.

Quote

Markdown block quote.

Fields

§id: String

Stable generated block id.

§text: String

Plain quote text.

§source: Option<SourceSpan>

Source span when available.

§annotations: Vec<AnnotationRef>

Inline annotation markers in this block.

MathBlock

Markdown display math block.

Fields

§id: String

Stable generated block id.

§text: String

Literal math text.

§source: Option<SourceSpan>

Source span when available.

TableRef

MCD table placement.

Fields

§id: String

Stable generated block id.

§placement: TablePlacement

Parsed table placement.

§source: Option<SourceSpan>

Source span when available.

ImageRef

MCD image placement.

Fields

§id: String

Stable generated block id.

§placement: ImagePlacement

Parsed image placement.

§source: Option<SourceSpan>

Source span when available.

Implementations§

impl DocumentBlock

pub fn id(&self) -> &str

Return the stable block id.

pub fn annotation_refs(&self) -> &[AnnotationRef]

Return annotation refs attached to the block.

Trait Implementations§

impl Clone for DocumentBlock

fn clone(&self) -> Self

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 DocumentBlock

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for DocumentBlock

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Eq for DocumentBlock

impl PartialEq for DocumentBlock

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl Serialize for DocumentBlock

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for DocumentBlock

Auto Trait Implementations§

impl Freeze for DocumentBlock

impl RefUnwindSafe for DocumentBlock

impl Send for DocumentBlock

impl Sync for DocumentBlock

impl Unpin for DocumentBlock

impl UnsafeUnpin for DocumentBlock

impl UnwindSafe for DocumentBlock

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

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

type Output = T

Should always be Self

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 = !

The type returned in the event of a conversion error.

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

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<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V