Struct OptionsBuilder 

#[non_exhaustive]
pub struct OptionsBuilder<'a> { /* private fields */ }

Builder for Options that provides an API for configuration.

Create an OptionsBuilder using Options::builder().

Example

use acdc_parser::{Options, SafeMode};

let options = Options::builder()
    .with_safe_mode(SafeMode::Safe)
    .with_timings()
    .with_attribute("toc", "left")
    .with_attribute("sectnums", true)
    .build();

Implementations

impl<'a> OptionsBuilder<'a>

pub fn with_safe_mode(self, safe_mode: SafeMode) -> Self

Set the safe mode for parsing.

Example

use acdc_parser::{Options, SafeMode};

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

pub fn with_timings(self) -> Self

Enable timing information during parsing.

Example

use acdc_parser::Options;

let options = Options::builder()
    .with_timings()
    .build();

pub fn with_strict(self) -> Self

Enable strict mode.

When enabled, issues that would normally result in a warning and fallback behavior will instead cause parsing to fail.

Example

use acdc_parser::Options;

let options = Options::builder()
    .with_strict()
    .build();

pub fn with_attribute( self, name: impl Into<Cow<'a, str>>, value: impl Into<AttributeValue<'a>>, ) -> Self

Add a document attribute with a string value.

This is a convenience method that accepts various types for the value:

• &str becomes AttributeValue::String
• bool becomes AttributeValue::Bool
• () becomes AttributeValue::None

Example

use acdc_parser::Options;

let options = Options::builder()
    .with_attribute("toc", "left")
    .with_attribute("sectnums", true)
    .build();

pub fn with_attributes( self, document_attributes: DocumentAttributes<'a>, ) -> Self

Set all document attributes at once.

Example

use acdc_parser::{Options, DocumentAttributes, AttributeValue};

let mut attrs = DocumentAttributes::default();
attrs.insert("toc".into(), AttributeValue::String("left".into()));

let options = Options::builder()
    .with_attributes(attrs)
    .build();

pub fn build(self) -> Options<'a>

Build the Options from this builder.

Example

use acdc_parser::{Options, SafeMode};

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

Trait Implementations

impl<'a> Clone for OptionsBuilder<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for OptionsBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for OptionsBuilder<'a>

fn default() -> OptionsBuilder<'a>

Returns the “default value” for a type.