Struct DocumentBuilder 

pub struct DocumentBuilder { /* private fields */ }

Builder for creating Codex documents.

Implementations

impl DocumentBuilder

pub fn new() -> Self

Create a new document builder.

pub fn title(self, title: impl Into<String>) -> Self

Set the document title.

pub fn creator(self, creator: impl Into<String>) -> Self

Set the document creator.

pub fn description(self, description: impl Into<String>) -> Self

Set the document description.

pub fn language(self, language: impl Into<String>) -> Self

Set the document language.

pub fn state(self, state: DocumentState) -> Self

Set the document state.

pub fn hash_algorithm(self, algorithm: HashAlgorithm) -> Self

Set the hash algorithm.

pub fn add_block(self, block: Block) -> Self

Add a content block.

pub fn add_heading(self, level: u8, text: impl Into<String>) -> Self

Add a heading block.

pub fn add_paragraph(self, text: impl Into<String>) -> Self

Add a paragraph block.

pub fn add_code_block( self, code: impl Into<String>, language: Option<String>, ) -> Self

Add a code block.

pub fn with_content(self, content: Content) -> Self

Set pre-built content, overriding any blocks added via add_block().

pub fn with_dublin_core(self, dublin_core: DublinCore) -> Self

Set pre-built Dublin Core metadata, overriding title/creator/description/language.

pub fn build(self) -> Result<Document>

Build the document.

Errors

Returns an error if the document cannot be constructed.

Trait Implementations

impl Clone for DocumentBuilder

fn clone(&self) -> DocumentBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocumentBuilder

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

Formats the value using the given formatter.

impl Default for DocumentBuilder

fn default() -> Self

Returns the “default value” for a type.