Skip to main content

parse

Function parse 

Source
pub fn parse(input: &str, options: &Options<'_>) -> Result<ParseResult, Error>
Expand description

Parse AsciiDoc content from a string.

The default SafeMode::Secure turns include directives into links without reading their targets. Select a lower safe mode to enable include reads. Options::include_loader defaults to IncludeLoader::System.

§Example

Enable includes relative to a directory:

use acdc_parser::{IncludeLoader, Options, SafeMode, parse};

let options = Options::builder()
    .with_safe_mode(SafeMode::Safe)
    .with_include_loader(IncludeLoader::System)
    .with_base_dir("/workspace/docs")
    .build()?;
let document = parse("include::part.adoc[]", &options)?;

§Example

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

let options = Options::builder()
    .with_safe_mode(SafeMode::Unsafe)
    .build()?;
let content = "= Document Title\n\nThis is a paragraph.\n\n== Section Title\n\nThis is a subsection.";
let document = parse(content, &options)?;

§Errors

Returns an error if preprocessing fails or the document cannot be parsed. Recoverable problems appear in the result’s warnings.