Skip to main content

LineKind

Enum LineKind 

Source
#[non_exhaustive]
pub enum LineKind { Para, Heading { level: u8, }, Code { lang: Option<String>, }, Island, Rule, Unknown { tag: String, attrs: Value, }, }
Expand description

The block role of a line. The tree between lines is inferred: two adjacent lines with equal kind+containers are two blocks of that role (e.g. two paragraphs), never one.

Open, on the same terms as MarkKind: an unrecognized role round-trips as LineKind::Unknown and projects as LineKind::Para, so adding a block construct (a callout, a footnote, a task item) is not a document schema event, an older reader renders the future construct as a plain paragraph instead of refusing the whole document, and the opaque tag+attrs still reach a reader that understands them (DOCUMENT_STORAGE.md § Open vocabularies).

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Para

§

Heading

ATX/Setext heading, level 1..=6.

Fields

§level: u8
§

Code

A line of a code block. lang is the (sanitized) info string, shared by every line of the same block.

Fields

§

Island

A block-level island: the line’s sole content is one ISLAND_SLOT.

§

Rule

A thematic break (---/***/___). The line carries no text: the break is the line itself, parallel to how an island’s content is its one slot char.

§

Unknown

Open-set escape hatch: a block role this build does not know, round-tripped opaque and projected as LineKind::Para. Carries arbitrary text, like the Para it projects as, so no LineKindMismatch constrains it.

Fields

§attrs: Value

Implementations§

Source§

impl LineKind

Source

pub fn projects_as_para(&self) -> bool

Whether the line projects as a paragraph: LineKind::Para itself, or an unknown role, which every projection renders as one. For the tests a match cannot serve: a matches!(kind, Para) that special-cases the paragraph (suppressing an empty block, say) reads as complete but drops the open arm, and the two emitters then drift on the construct neither knows.

An exhaustive match keeps listing both arms, and in this crate the compiler still polices that: #[non_exhaustive] does not apply within the defining crate. It does apply to the typst backend, whose emitter folds both arms into one wildcard; there the ladder, not the compiler, is what keeps a new role rendering.

Trait Implementations§

Source§

impl Clone for LineKind

Source§

fn clone(&self) -> LineKind

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 LineKind

Source§

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

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

impl PartialEq for LineKind

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for LineKind

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