Struct Document 

pub struct Document {
    pub paragraphs: Vec<Paragraph>,
}

A collection of top-level Paragraph nodes that make up an FTML document.

The struct is intentionally lightweight: it simply stores the top-level paragraphs in the order in which they should render.

Examples

Building a document manually:

use tdoc::{Document, Paragraph, Span};

let mut doc = Document::new();
let paragraph = Paragraph::new_text().with_content(vec![Span::new_text("Hello!")]);
doc.add_paragraph(paragraph);

assert_eq!(doc.paragraphs.len(), 1);
assert!(!doc.is_empty());

Fields

paragraphs: Vec<Paragraph>

Implementations

impl Document

pub fn new() -> Self

Creates an empty document with no paragraphs.

pub fn with_paragraphs(self, paragraphs: Vec<Paragraph>) -> Self

Replaces the document’s paragraphs, returning the updated document.

pub fn add_paragraph(&mut self, paragraph: Paragraph)

Appends a new paragraph to the end of the document.

pub fn is_empty(&self) -> bool

Returns true when the document contains no paragraphs.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Document

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Document