Struct outline::document::Document

pub struct Document<'a> { /* fields omitted */ }

A representation of a Document of literate code

Methods

impl<'a> Document<'a>

pub fn print_docs<P: Printer>(&self, printer: &P) -> String

Formats this Document as a string containing the documentation file contents

pub fn print_code(
    &self,
    entrypoint: Option<&str>,
    language: Option<&str>
) -> Result<String, CompileError>

Formats this Document as a string containing the compiled code

Trait Implementations

impl<'a, T> From<T> for Document<'a> where
    Ast<'a>: From<T>, 

fn from(value: T) -> Self

Performs the conversion.

impl<'a> Debug for Document<'a>

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

Formats the value using the given formatter.

impl<'a, T> FromIterator<T> for Document<'a> where
    Ast<'a>: FromIterator<T>, 

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.