Struct Rich 

pub struct Rich {
    pub v: u32,
    pub blocks: Vec<Block>,
}

A rich payload: the object stored under the content key ({"v":1,"blocks":[...]}).

Fields

v: u32

Payload version (RICH_VERSION).

blocks: Vec<Block>

The blocks, drawn in order under the message.

Implementations

impl Rich

pub fn math(tex: &str, display: bool) -> Self

One math block (display false: inline math).

pub fn math_only(&self) -> Option<Math>

The math of a payload whose only block is a math block: such a message is sent as an m.image (the PNG render) when it has no separate text. None for anything else.

pub fn find_math(&self) -> Option<(&str, bool)>

The first math block’s TeX and whether it is display math (the default), in any payload (unlike Rich::math_only).

pub fn stream(id: &str, url: Option<&str>, state: StreamState) -> Self

One stream block.

pub fn buttons(buttons: Vec<Button>) -> Self

One buttons block.

pub fn parse(json: &str) -> Result<Self, String>

Parses a payload, turns its floats into decimal strings (Rich::canonicalize) and validates it.

pub fn canonicalize(&mut self) -> Result<(), String>

Makes the payload canonical JSON, which event content must be: every float becomes an integer (no fraction) or its shortest decimal string (62.99 → "62.99"). Senders call this before Rich::validate, so callers that write floats keep working. Integers outside ±MAX_SAFE_INT are an error.

pub fn validate(&self) -> Result<(), String>

Whether this version can send it: known v, 1..=MAX_BLOCKS blocks of known types, 1..=MAX_BUTTONS buttons (or 1..=MAX_CHIPS chips) per action block with labels of 1..=MAX_LABEL characters, non-empty react keys and send bodies, display blocks with their required fields, and the size caps.

pub fn form_fallback(&self) -> Option<String>

A plain-text body for the payload’s forms (form_fallback), or None without forms: a sender’s default text when it has none.

pub fn react_keys(&self) -> Vec<String>

The keys of every react action (buttons, chips, card actions), in order, without duplicates.

pub fn texts(&self) -> Vec<String>

Every user-visible string of the actions (labels, keys, send bodies).

Trait Implementations

impl Clone for Rich

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rich

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rich

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Rich

impl PartialEq for Rich

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Rich

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Rich