Struct sidoc::Builder

pub struct Builder { /* fields omitted */ }

Constructor for Doc objects.

Implementations

impl Builder

pub fn new() -> Self

Create a new Doc builder context.

pub fn scope<L: ToString, K: ToString>(
    &mut self,
    begin_line: L,
    term_line: Option<K>
) -> &mut Self

Begin a scope, pushing an optional scope terminator to the internal scope stack.

If the scope generated using a terminator line, that line will appended to the document when the scope is closed using the exit() method.

pub fn exit(&mut self) -> &mut Self

Leave a previously entered scope.

If the scope() call that created the current scope

pub fn exit_line<L: ToString>(&mut self, line: L) -> &mut Self

Leave previously entered scope, adding a line passed by the caller rather than the scope stack.

pub fn line<L: ToString>(&mut self, line: L) -> &mut Self

Add a new line at current scope.

pub fn optref<N: ToString>(&mut self, name: N) -> &mut Self

Add a named optional reference.

References are placeholders for other documents. An optional reference means that this reference does not need to be resolved by the renderer.

pub fn reqref<N: ToString>(&mut self, name: N) -> &mut Self

Add a named required reference.

References are placeholders for other documents. A required reference must be resolved by the renderer or it will return an error to its caller.

pub fn build(self) -> Result<Doc, Error>

Generate a Doc object from this document.

The document must be properly nested before calling this function, meaning all scopes it opened must be closed.