Struct Parser 

pub struct Parser<'input> { /* private fields */ }

Type-based parser for AsciiDoc content.

Parser provides a more discoverable, fluent API for parsing AsciiDoc documents.

Examples

Basic usage:

use acdc_parser::Parser;

let content = "= Document Title\n\nParagraph text.";
let doc = Parser::new(content).parse()?;

With options:

use acdc_parser::{Parser, Options, SafeMode};

let content = "= Document Title\n\nParagraph text.";
let options = Options::builder()
    .with_safe_mode(SafeMode::Safe)
    .with_timings()
    .build();

let doc = Parser::new(content)
    .with_options(options)
    .parse()?;

For file-based parsing, read the file first:

use acdc_parser::Parser;
use std::fs;

let content = fs::read_to_string("document.adoc")?;
let doc = Parser::new(&content).parse()?;

Implementations

impl<'input> Parser<'input>

pub fn new(input: &'input str) -> Self

Create a new parser for the given input string.

The parser will use default options. Use with_options to customize.

Example

use acdc_parser::Parser;

let parser = Parser::new("= Title\n\nContent");
let doc = parser.parse()?;

pub fn with_options(self, options: Options) -> Self

Set the options for this parser.

This consumes the parser and returns a new one with the specified options.

Example

use acdc_parser::{Parser, Options, SafeMode};

let options = Options::builder()
    .with_safe_mode(SafeMode::Safe)
    .build();

let parser = Parser::new("= Title")
    .with_options(options);

pub fn parse(self) -> Result<Document, Error>

Parse the input into a Document.

Example

use acdc_parser::Parser;

let doc = Parser::new("= Title\n\nContent").parse()?;

Errors

Returns an error if the input cannot be parsed as valid AsciiDoc.

pub fn parse_inline(self) -> Result<Vec<InlineNode>, Error>

Parse only inline elements from the input.

This is useful for parsing fragments of AsciiDoc that contain only inline markup like bold, italic, links, etc.

Example

use acdc_parser::Parser;

let inlines = Parser::new("This is *bold* text").parse_inline()?;

Errors

Returns an error if the input cannot be parsed.

Trait Implementations

impl<'input> Debug for Parser<'input>

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

Formats the value using the given formatter.