Struct Options 

#[non_exhaustive]
pub struct Options {
    pub safe_mode: SafeMode,
    pub timings: bool,
    pub document_attributes: DocumentAttributes,
    pub strict: bool,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

safe_mode: SafeMode

timings: bool

document_attributes: DocumentAttributes

strict: bool

Strict mode - fail on non-conformance instead of warn-and-continue.

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

• Non-conforming manpage titles (not matching name(volume) format)

Implementations

impl Options

pub fn builder() -> OptionsBuilder

Create a new OptionsBuilder for fluent configuration.

Example

use acdc_parser::{Options, SafeMode};

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

pub fn new() -> Self

Create a new Options with default settings.

Equivalent to Options::default().

pub fn with_attributes(document_attributes: DocumentAttributes) -> Self

Create a new Options with the given document attributes.

Example

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

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

let options = Options::with_attributes(attrs);

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.