Struct outline::document::code::CodeBlock

pub struct CodeBlock<'a> {
    pub indent: &'a str,
    pub name: Option<String>,
    pub vars: Vec<&'a str>,
    pub language: Option<String>,
    pub source: Vec<Line<'a>>,
}

A CodeBlock is a block of code as defined by the input format.

Fields

indent: &'a str

The indent of this code block is in the documentation file

name: Option<String>

The name of this code block

vars: Vec<&'a str>

The variables extracted from the name

language: Option<String>

The language this block was written in

source: Vec<Line<'a>>

The source is the lines of code

Methods

impl<'a> CodeBlock<'a>

pub fn new() -> Self

Creates a new empty CodeBlock

pub fn indented(self, indent: &'a str) -> Self

Indents this code block

pub fn named(self, name: String, vars: Vec<&'a str>) -> Self

Names this code block

pub fn in_language(self, language: String) -> Self

Sets the language of this code block

pub fn add_line(&mut self, line: Line<'a>)

Adds a line to this code block

pub fn append(&mut self, other: &CodeBlock<'a>)

Appends another code block to the end of this one

pub fn compile(
    &self,
    code_blocks: &HashMap<Option<&str>, CodeBlock<'a>>
) -> Result<String, CompileError>

"Compiles" this code block into its output code

pub fn line_number(&self) -> Option<usize>

Returns the line number of the first line in this code block

Trait Implementations

impl<'a> Default for CodeBlock<'a>

fn default() -> CodeBlock<'a>

Returns the "default value" for a type.

impl<'a> Clone for CodeBlock<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CodeBlock<'a>

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

Formats the value using the given formatter.