Skip to main content

Block

Enum Block 

Source
pub enum Block {
    Text {
        id: String,
        text: String,
    },
    Fields {
        id: String,
        items: Vec<Field>,
    },
    Table {
        id: String,
        columns: Vec<String>,
        rows: Vec<Vec<Value>>,
        offset: Option<u64>,
        total: Option<u64>,
    },
    List {
        id: String,
        items: Vec<Value>,
        ordered: Option<bool>,
        offset: Option<u64>,
        total: Option<u64>,
    },
    Custom {
        id: String,
        payload: Value,
    },
    Notice {
        id: String,
        severity: Severity,
        text: String,
    },
    Media {
        id: String,
        mime_type: String,
        url: String,
        alt: Option<String>,
    },
}
Expand description

One semantic block. The id is assigned by the library (constructors leave it empty; it is filled in when the block is inserted into a window).

Note: this enum deliberately uses internal tagging #[serde(tag = "type")] — this is the wire format mandated by MCP GUI Bridge protocol §4.4 ({"type":"text","id":...,"text":...}). It cannot use serde’s default external tagging without violating the protocol and breaking agent interop. This is the single documented exception to the the repo’s docs/code-style.md “no tag="type"” rule (that rule targets WASM binary size and does not apply to this server crate).

Variants§

§

Text

A paragraph of text.

Fields

§id: String

Block id (library-assigned).

§text: String

The text content.

§

Fields

A group of key/value fields.

Fields

§id: String

Block id (library-assigned).

§items: Vec<Field>

The field items.

§

Table

A table.

Fields

§id: String

Block id (library-assigned).

§columns: Vec<String>

Column headers, left to right.

§rows: Vec<Vec<Value>>

Row data; rows[i][j] aligns with columns[j].

§offset: Option<u64>

Offset of the first row when truncated (§9); defaults to absent (0).

§total: Option<u64>

Total row count when truncated (§9).

§

List

A list.

Fields

§id: String

Block id (library-assigned).

§items: Vec<Value>

List items.

§ordered: Option<bool>

true for an ordered list.

§offset: Option<u64>

Offset of the first item when truncated (§9).

§total: Option<u64>

Total item count when truncated (§9).

§

Custom

A fallback block carrying an arbitrary structured payload.

Fields

§id: String

Block id (library-assigned).

§payload: Value

Arbitrary payload.

§

Notice

A status / notice block.

Fields

§id: String

Block id (library-assigned).

§severity: Severity

Severity level.

§text: String

Notice text.

§

Media

Read-side rich media: an image / screenshot / chart.

Fields

§id: String

Block id (library-assigned).

§mime_type: String

MIME type, e.g. image/png.

§url: String

Where to fetch it: an https://, file://, or inline data:<mime>;base64,… URL.

§alt: Option<String>

Text description — the semantic fallback for the agent.

Implementations§

Source§

impl Block

Source

pub fn text(text: impl Into<String>) -> Block

Build a text block.

Source

pub fn fields<I, F>(items: I) -> Block
where I: IntoIterator<Item = F>, F: Into<Field>,

Build a fields block from any iterable of items convertible to Field.

Source

pub fn table<C, R, Row, Cell>(columns: C, rows: R) -> Block
where C: IntoIterator<Item = Cell>, Cell: Into<String>, R: IntoIterator<Item = Row>, Row: IntoIterator, <Row as IntoIterator>::Item: Serialize,

Build a table block. Cells accept any Serialize.

Source

pub fn table_truncated<C, R, Row, Cell>( columns: C, rows: R, offset: u64, total: u64, ) -> Block
where C: IntoIterator<Item = Cell>, Cell: Into<String>, R: IntoIterator<Item = Row>, Row: IntoIterator, <Row as IntoIterator>::Item: Serialize,

Build a truncated table block (§9): rows is the shown window, starting at offset, out of total rows overall.

Source

pub fn list<I, T>(items: I) -> Block
where I: IntoIterator<Item = T>, T: Serialize,

Build an unordered list block. Items accept any Serialize.

Source

pub fn ordered_list<I, T>(items: I) -> Block
where I: IntoIterator<Item = T>, T: Serialize,

Build an ordered list block. Items accept any Serialize.

Source

pub fn list_truncated<I, T>( items: I, ordered: bool, offset: u64, total: u64, ) -> Block
where I: IntoIterator<Item = T>, T: Serialize,

Build a truncated list block (§9): items is the shown window, starting at offset, out of total items overall. ordered selects an ordered (1. 2. 3.) or unordered list.

Source

pub fn notice(severity: Severity, text: impl Into<String>) -> Block

Build a notice block.

Source

pub fn custom(payload: impl Serialize) -> Block

Build a custom block. The payload accepts any Serialize.

Source

pub fn media(mime_type: impl Into<String>, url: impl Into<String>) -> Block

Build a media block (read-side rich media: image / screenshot / chart). url may be https://, file://, or an inline data:<mime>;base64,… URL; alt starts empty (set it via the handle).

Trait Implementations§

Source§

impl Clone for Block

Source§

fn clone(&self) -> Block

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<(), Error>

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

impl Serialize for Block

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

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

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

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

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,