Struct ParserConfig 

pub struct ParserConfig {
    pub comments: bool,
}

ParserConfig for reading Links Notation documents.

Provides configuration options for controlling how a document is read.

Fields

comments: bool

If true, a # written where a line or a token starts opens a comment that runs to the end of the line (default: true)

Implementations

impl ParserConfig

pub fn new() -> Self

Create a new ParserConfig with default values

Examples

use links_notation::ParserConfig;

assert!(ParserConfig::new().comments);

pub fn without_comments() -> Self

Create a ParserConfig that reads # as an ordinary reference character, the way documents written before comments existed were read.

Examples

use links_notation::{parse_lino_with_config, ParserConfig};

let parsed = parse_lino_with_config("# a b", &ParserConfig::without_comments()).unwrap();
assert_eq!(format!("{}", parsed), "((# a b))");

Examples found in repository

examples/comments.rs (line 27)

fn main() {
    let documents = [
        "# a note about the document\ndeploy: staging\n",
        "deploy: staging # only staging, for now\n",
        "issue#1047: open\n",
        "\"# not a comment\": still a reference\n",
        "parent\n  # what the child is for\n  child\n",
    ];

    for document in documents {
        match parse_lino(document) {
            Ok(links) => println!("{document:?}\n  parses as {links}"),
            Err(error) => println!("{document:?}\n  {error}"),
        }
    }

    // Documents that predate comments can be read with `#` as an ordinary
    // character.
    let config = ParserConfig::without_comments();
    let document = "# a b\n";
    match parse_lino_with_config(document, &config) {
        Ok(links) => println!("\nwithout comments {document:?}\n  parses as {links}"),
        Err(error) => println!("\nwithout comments {document:?}\n  {error}"),
    }
}

pub fn with_comments(comments: bool) -> Self

Create a ParserConfig that turns comments on or off

Examples

use links_notation::ParserConfig;

assert_eq!(ParserConfig::with_comments(false), ParserConfig::without_comments());

Trait Implementations

impl Clone for ParserConfig

fn clone(&self) -> ParserConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParserConfig

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

Formats the value using the given formatter.

impl Default for ParserConfig

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ParserConfig

impl PartialEq for ParserConfig

fn eq(&self, other: &ParserConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ParserConfig