Struct templar::Data

pub struct Data { /* fields omitted */ }

The Data struct is used to represent the raw execution result of a node in a template. Data can currently be in one of three states:

• Empty: The execution was successful but there was no result associated. For example, value assignments (x = y)
• Success: The document data can be safely retrieved
• Failure: An error occurred executing this node

Implementations

impl<'a> Data

pub fn empty() -> Data

Create a new empty result

pub fn render(self) -> Result<String>

Render this result

If the data is empty, an empty string is returned. If this data is in an error state, the error is returned Otherwise, the rendered string is returned

pub fn is_failed(&self) -> bool

Check if this data struct has a failure

pub fn is_empty(&self) -> bool

Check if this data struct is empty

pub fn unwrap(self) -> Document

Unwrap the data contents

PANIC!

This will panic if this data struct is empty or contains an error

pub fn unwrap_err(self) -> TemplarError

Unwrap the data error

PANIC!

This will panic if this data struct is empty or does not contain an error

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

Convert the data into a Result. In the case of empty data, an empty string is returned.

pub fn clone_result(&self) -> Result<Document>

Clone this data into a new Result

pub fn to_result(&'a self) -> Result<&'a Document>

Retrieve a result with a reference to the underlying document

pub fn from_result(result: Result<Document>) -> Data

Create Data from a result

Trait Implementations

impl Clone for Data

fn clone(&self) -> Data

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Data

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

Formats the value using the given formatter.

impl<T: Into<Document>> From<T> for Data

fn from(doc: T) -> Self

Performs the conversion.

impl From<TemplarError> for Data

fn from(error: TemplarError) -> Self

Performs the conversion.