Struct Document

pub struct Document { /* private fields */ }

The root document itself, this contains a list of BlockContent values as well as a list of metadata properties.

Note that the add_ and set_ methods all return &mut Self and so calls to these may be chained.

Implementations

impl Document

pub fn has_metadata(&self) -> bool

Returns true if this document has any associated metadata, else false.

pub fn metadata(&self) -> &Vec<Metadata>

Return the list of associated metadata.

pub fn add_metadata(&mut self, datum: Metadata) -> &mut Self

Add a metadata item to this document.

pub fn set_title(&mut self, v: &str) -> &mut Self

Set the title (metadata value) of this document.

pub fn set_date(&mut self, v: &str) -> &mut Self

Set the date (metadata value) of this document.

pub fn add_author(&mut self, v: Author) -> &mut Self

Add an author (metadata value) to this document.

pub fn add_author_str( &mut self, name: &str, email: Option<&str>, organization: Option<&str>, ) -> &mut Self

Add an author (metadata value) to this document.

pub fn add_copyright(&mut self, v: Copyright) -> &mut Self

Add a copyright (metadata value) to this document.

pub fn add_copyright_str( &mut self, year: u16, organization: Option<&str>, comment: Option<&str>, ) -> &mut Self

Add a copyright (metadata value) to this document.

pub fn add_keywords(&mut self, v: &[String]) -> &mut Self

Add a list of keywords (metadata value) to this document.

pub fn add_keywords_str(&mut self, v: &[&str]) -> &mut Self

Add a list of keywords (metadata value) to this document.

pub fn add_metadata_property(&mut self, v: SimpleProperty) -> &mut Self

Add an arbitrary, named, metadata value)to this document.

pub fn add_metadata_property_str( &mut self, name: &str, value: &str, ) -> &mut Self

Add an arbitrary, named, metadata value)to this document.

pub fn has_abstract(&self) -> bool

Returns true if an abstract has been added to this document, else false.

pub fn add_abstract(&mut self, abstract_block: Paragraph) -> &mut Self

Add a Paragraph acting as the abstract to this document.

pub fn abstract_block(&self) -> &Option<Paragraph>

Return the Paragraph, if present, acting as the abstract to this document.

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<'de> Deserialize<'de> for Document

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl HasBlockContent for Document

fn from(inner: BlockContent) -> Self

Create a new block content container from the provided content item.

fn comment(inner: String) -> Self

Create a new block content container from the provided String content item.

fn front_matter(matter: FrontMatter) -> Self

Create a new block content container from the provided FrontMatter content item.

fn heading(inner: Heading) -> Self

Create a new block content container from the provided Heading content item.

fn image(inner: ImageBlock) -> Self

Create a new block content container from the provided ImageBlock content item.

fn math(inner: MathBlock) -> Self

Create a new block content container from the provided MathBlock content item.

fn list(inner: List) -> Self

Create a new block content container from the provided List content item.

fn definition_list(inner: DefinitionList) -> Self

Create a new block content container from the provided DefinitionList content item.

fn formatted(inner: Formatted) -> Self

Create a new block content container from the provided Formatted content item.

fn code_block(inner: CodeBlock) -> Self

Create a new block content container from the provided CodeBlock content item.

fn paragraph(inner: Paragraph) -> Self

Create a new block content container from the provided Paragraph content item.

fn block_quote(inner: Quote) -> Self

Create a new block content container from the provided Quote content item.

fn table(inner: Table) -> Self

Create a new block content container from the provided Table content item.

fn thematic_break() -> Self

Create a new block content container with a thematic break.

fn add_comment_str(&mut self, inner: &str) -> &mut Self

Add the provided Comment to this container’s inner content.

fn add_front_matter(&mut self, matter: FrontMatter) -> &mut Self

Add the provided FrontMatter to this container’s inner content.

fn add_heading(&mut self, inner: Heading) -> &mut Self

Add the provided Heading to this container’s inner content.

fn add_image(&mut self, inner: ImageBlock) -> &mut Self

Add the provided ImageBlock to this container’s inner content.

fn add_math(&mut self, inner: MathBlock) -> &mut Self

Add the provided MathBlock to this container’s inner content.

fn add_list(&mut self, inner: List) -> &mut Self

Add the provided List to this container’s inner content.

fn add_definition_list(&mut self, inner: DefinitionList) -> &mut Self

Add the provided DefinitionList to this container’s inner content.

fn add_formatted(&mut self, inner: Formatted) -> &mut Self

Add the provided Formatted to this container’s inner content.

fn add_code_block(&mut self, inner: CodeBlock) -> &mut Self

Add the provided CodeBlock to this container’s inner content.

fn add_paragraph(&mut self, inner: Paragraph) -> &mut Self

Add the provided Paragraph to this container’s inner content.

fn add_block_quote(&mut self, inner: Quote) -> &mut Self

Add the provided Quote to this container’s inner content.

fn add_table(&mut self, inner: Table) -> &mut Self

Add the provided Table to this container’s inner content.

fn add_thematic_break(&mut self) -> &mut Self

Add a ThematicBreak to this container’s inner content.

impl HasInnerContent<BlockContent> for Document

fn inner(&self) -> &Vec<BlockContent>

Return a reference to the inner value.

fn into_inner(self) -> Vec<BlockContent>

Return the inner value, consuming self.

fn inner_mut(&mut self) -> &mut Vec<BlockContent>

Return a mutable reference to the inner list of content.

fn add_content(&mut self, content: BlockContent) -> Result<()>

Add content to the inner list of content. If there is some consistency condition that would be broken by this addition an error will be returned.

fn has_inner(&self) -> bool

Returns true if the inner list of content is not empty, else false.

impl Into<Document> for BlockContent

fn into(self) -> Document

Converts this type into the (usually inferred) input type.

impl Serialize for Document

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

where __S: Serializer,

Serialize this value into the given Serde serializer.