Skip to main content

Document

Struct Document 

Source
pub struct Document {
    pub blocks: Vec<Block>,
}
Expand description

A normalized rich message document: an ordered list of top-level blocks.

Fields§

§blocks: Vec<Block>

Top-level blocks of the document.

Implementations§

Source§

impl Document

Source

pub fn fit(&mut self, opts: &FitOptions) -> bool

Fits the document into opts.limits and appends opts.tail.

The following adjustments are applied in order:

  1. Table rows wider than max_table_columns lose their extra cells.
  2. Media beyond max_media are replaced by plain links.
  3. Formatting and containers nested deeper than max_depth are unwrapped / flattened.
  4. If characters or blocks still exceed the limits, the content is cut at the last block that fits (descending into lists, quotes, details and tables, and cutting text blocks mid-text if needed), and opts.truncation_notice is appended.

Returns true if content was truncated in step 4.

Source§

impl Document

Source

pub fn stats(&self) -> Stats

Measures the document.

Counting is conservative: list items, table rows and the content blocks of containers are all counted as blocks, and every formatting wrapper adds one nesting level.

Source§

impl Document

Source

pub fn to_html(&self) -> String

Renders the document to Telegram Rich HTML, suitable for InputRichMessage::html.

Source

pub fn to_input_rich_message(&self) -> InputRichMessage

Renders the document and wraps it into an InputRichMessage.

Source§

impl Document

Source

pub fn new(blocks: Vec<Block>) -> Self

Creates a document from blocks.

Source

pub fn is_empty(&self) -> bool

Returns true if the document has no blocks.

Source

pub fn for_each_media_mut(&mut self, f: impl FnMut(&mut Media))

Visits every media element mutably, e.g. to rewrite URLs to tg://photo?id=… references for explicit uploads.

Source

pub fn media(&self) -> Vec<&Media>

Collects references to every media element in document order.

Trait Implementations§

Source§

impl Clone for Document

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 Document

Source§

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

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

impl Default for Document

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Document

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 Document

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

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.