Struct outline::parser::bird::BirdParser

pub struct BirdParser {
    pub code_marker: String,
    pub code_name_marker: String,
    pub comment_start: String,
    pub interpolation_start: String,
    pub interpolation_end: String,
    pub macro_start: String,
    pub macro_end: String,
}

The config for parsing a Bird Style document

Fields

code_marker: String

The line starter to identify code lines

Default: >

code_name_marker: String

The line starter to identify the name of a code block

Default: >>>

comment_start: String

The sequence to identify a comment which should be omitted from the compiled code.

Default: //

interpolation_start: String

The sequence to identify the start of a meta variable interpolation.

Default: @{

interpolation_end: String

The sequence to identify the end of a meta variable interpolation.

Default: }

macro_start: String

The sequence to identify the start of a macro invocation.

Default: ==>

macro_end: String

The sequence to identify the end of a macro invocation.

Default: .

Trait Implementations

impl Debug for BirdParser

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

Formats the value using the given formatter.

impl Default for BirdParser

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BirdParser

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Parser for BirdParser

type Error = BirdError

The type of error for this parser

fn parse<'a>(&self, input: &'a str) -> Result<Document<'a>, Self::Error>

Parses the text part of the document. Should delegate the code section on a line-by-line basis to the built in code parser.

fn parse_name<'a>(
    &self,
    input: &'a str
) -> Result<(String, Vec<&'a str>), ParseError>

Parses a macro name, returning the name and the extracted variables

fn parse_line<'a>(
    &self,
    line_number: usize,
    input: &'a str
) -> Result<Line<'a>, ParseError>

Parses a line as code, returning the parsed Line object

impl ParserConfig for BirdParser

fn comment_start(&self) -> &str

The token to denote the start of a comment that should be rendered in the documentation. This may be specified as the actual line comment symbol used by the source language to exclude all comments from the transpiled file, or it can be a completely separate symbol to allow for some comments to be left untouched even in the output files.

fn interpolation_start(&self) -> &str

The token to denote the start of a meta-variable interpolation

fn interpolation_end(&self) -> &str

The token to denote the end of a meta-variable interpolation

fn macro_start(&self) -> &str

The token to denote the start of a macro invocation

fn macro_end(&self) -> &str

The token to denote the end of a macro invocation

impl Printer for BirdParser

fn print_text_block<'a>(&self, block: &TextBlock<'a>) -> String

Prints a text block

fn print_code_block<'a>(&self, block: &CodeBlock<'a>) -> String

Prints a code block

fn print_name(&self, name: String, vars: &[&str]) -> String

Fills a name with its placeholders

fn print_line<'a>(&self, line: &Line<'a>, print_comments: bool) -> String

Prints a line of a code block