Skip to main content

Block

Enum Block 

Source
pub enum Block {
    Heading {
        level: u8,
        text: String,
    },
    Paragraph {
        text: String,
    },
    Line {
        text: String,
    },
    Separator,
    List {
        ordered: bool,
        items: Vec<String>,
    },
    Code {
        language: Option<String>,
        code: String,
    },
    Table {
        title: Option<String>,
        table: Table,
    },
    Json {
        value: Value,
    },
    KeyValue {
        entries: Vec<KeyValueEntry>,
    },
    DefinitionList {
        entries: Vec<DefinitionEntry>,
    },
    Status {
        kind: StatusKind,
        text: String,
    },
    StyledText {
        text: String,
        style: TextStyle,
    },
}
Expand description

A content block within an output.

Blocks are rendered according to the configured format (Markdown, JSON, etc.).

Variants§

§

Heading

Heading at the specified level (1-6).

Fields

§level: u8
§text: String
§

Paragraph

A paragraph of text.

Fields

§text: String
§

Line

A single line of text.

Fields

§text: String
§

Separator

A visual separator/divider.

§

List

An ordered or unordered list.

Fields

§ordered: bool
§items: Vec<String>
§

Code

A code block with optional language hint.

Fields

§language: Option<String>
§code: String
§

Table

A structured data table.

Fields

§table: Table
§

Json

Raw JSON data.

Fields

§value: Value
§

KeyValue

Key-value pairs.

Fields

§

DefinitionList

Term definitions.

Fields

§

Status

Status indicator (ok, warning, error).

Fields

§text: String
§

StyledText

Styled text block.

Fields

§text: String

Trait Implementations§

Source§

impl Clone for Block

Source§

fn clone(&self) -> Block

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

impl Debug for Block

Source§

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

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

impl Serialize for Block

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

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