Skip to main content

Block

Enum Block 

Source
pub enum Block {
Show 15 variants Paragraph(Vec<Inline>), Heading { level: u8, content: Vec<Inline>, }, Preformatted { language: Option<String>, text: String, }, Footer(Vec<Inline>), Divider, MathBlock(String), Anchor(String), List { ordered: bool, start: Option<i64>, items: Vec<ListItem>, }, Quote { blocks: Vec<Block>, credit: Option<Vec<Inline>>, }, ExpandableQuote { content: Vec<Inline>, credit: Option<Vec<Inline>>, }, PullQuote { content: Vec<Inline>, credit: Option<Vec<Inline>>, }, Media(Media), Table(Table), Details { summary: Vec<Inline>, blocks: Vec<Block>, open: bool, }, Buttons { align: Option<Align>, buttons: Vec<UrlButton>, },
}
Expand description

A block-level element.

Variants§

§

Paragraph(Vec<Inline>)

A text paragraph (<p>).

§

Heading

A section heading (<h1>–<h6>); level is clamped to 1..=6.

Fields

§level: u8

Heading level, 1 is the largest.

§content: Vec<Inline>

Heading content.

§

Preformatted

A preformatted block (<pre> / <pre><code class="language-…">).

Fields

§language: Option<String>

Optional programming language.

§text: String

Raw text, whitespace preserved.

§

Footer(Vec<Inline>)

A footer (<footer>).

§

Divider

A horizontal divider (<hr/>).

§

MathBlock(String)

A block formula (<tg-math-block>), raw LaTeX.

§

Anchor(String)

An anchor target (<a name="…"></a>).

§

List

An ordered or unordered list.

Fields

§ordered: bool

Whether the list is ordered (<ol>).

§start: Option<i64>

Optional start number for ordered lists.

§items: Vec<ListItem>

List items.

§

Quote

A block quotation (<blockquote>), may contain nested blocks.

Fields

§blocks: Vec<Block>

Quoted content.

§credit: Option<Vec<Inline>>

Optional credit (<cite>).

§

ExpandableQuote

An expandable block quotation (<blockquote expandable>), inline content only.

Fields

§content: Vec<Inline>

Quoted content; use Inline::LineBreak for line breaks.

§credit: Option<Vec<Inline>>

Optional credit (<cite>).

§

PullQuote

A pull quotation (<aside>).

Fields

§content: Vec<Inline>

Quoted content.

§credit: Option<Vec<Inline>>

Optional credit (<cite>).

§

Media(Media)

A standalone media element.

§

Table(Table)

A table; cells contain inline content only.

§

Details

A disclosure block (<details>).

Fields

§summary: Vec<Inline>

Always visible summary.

§blocks: Vec<Block>

Collapsible content.

§open: bool

Whether the block is expanded by default.

§

Buttons

A row of URL buttons (<tg-button-row>), 1–8 buttons.

Fields

§align: Option<Align>

Horizontal alignment.

§buttons: Vec<UrlButton>

Buttons in the row.

Implementations§

Source§

impl Block

Source

pub fn paragraph(s: impl Into<String>) -> Self

Convenience constructor for a paragraph containing plain text.

Convenience constructor for a single-button row linking to url.

Trait Implementations§

Source§

impl Clone for Block

Source§

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

impl Debug for Block

Source§

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

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

impl PartialEq for Block

Source§

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

impl StructuralPartialEq for Block

Auto Trait Implementations§

§

impl Forget for Block

§

impl Freeze for Block

§

impl Move for Block

§

impl RefUnwindSafe for Block

§

impl Send for Block

§

impl Sync for Block

§

impl Unpin for Block

§

impl UnsafeUnpin for Block

§

impl UnwindSafe for Block

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

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.