Struct bempline::Document

pub struct Document { /* fields omitted */ }

Methods

impl Document

pub fn new(text: &str) -> Self

pub fn set_variable(&mut self, key: &str, value: &str) -> usize

Returns a usize indicating how many variables were replaced

Replace every instance of variable key with text value

Example

use bempline::Document;

let mut doc = Document::new("Hello, {~ $noun ~}!");
let num_replaced = doc.set_variable("noun", "World");

assert_eq!(num_replaced, 1);
assert_eq!(doc.as_string(), "Hello, World!");

pub fn process_includes(&mut self) -> Result<usize, Error>

Returns a usize indicating the number of includes that were processed successfully.

Replaces every include command in the document with the content of the file it references.

Errors

Returns a Error if a file referenced by one of the include statements is unable to be opened for reading.

pub fn get_pattern(&self, name: &str) -> Result<Document, Error>

Returns a Document of the elements in the pattern

Retreives the pattern name

Errors

Returns a Error if the pattern does not exist.

pub fn set_pattern(
    &mut self,
    name: &str,
    pattern: Document
) -> Result<usize, Error>

Returns a usize indicating how many elements were inserted into the document.

Inserts the elementa from pattern into this document, before the pattern name

Errors

Returns a Error if the pattern does not exist.

pub fn as_string(self) -> String

Returns a string of this document.

Only text is included in the string. No variables, unproccesed includes, or patterns will be in the string.