Struct TextDocument 

pub(crate) struct TextDocument<'a> {
    parts: Vec<Part<'a>>,
}

A validated plain text document. Rendering cannot fail.

Fields

parts: Vec<Part<'a>>

Implementations

impl<'a> TextDocument<'a>

pub(crate) fn new( syntax: Option<CommentSyntax>, nodes: &'a [DocumentNode], ) -> Result<Self, TextError>

Validate the nodes against the comment syntax.

Errors

Returns an error when a comment node has no syntax to render with, contains a carriage return or another character that corrupts output, would contain the XML closing delimiter (-->) under CommentSyntax::Xml, or follows text that does not end a line.

impl TextDocument<'_>

pub(crate) fn generated(self, syntax: Option<CommentSyntax>) -> Self

Put the generated marker and a blank line in front, when the syntax can express a comment.

Trait Implementations

impl<'a> Clone for TextDocument<'a>

fn clone(&self) -> TextDocument<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TextDocument<'a>

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

Formats the value using the given formatter.

impl Display for TextDocument<'_>

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

Formats the value using the given formatter.