Struct Parser 

pub struct Parser { /* private fields */ }

Reusable parser with an explicit input policy.

Implementations

impl Parser

pub const fn new(options: ParseOptions) -> Self

Create a parser with the supplied include and compression policies.

pub const fn options(&self) -> &ParseOptions

Return this parser’s immutable configuration.

pub fn parse_file( &self, path: impl AsRef<Path>, ) -> Result<ParseReport, ParseError>

Parse one source path into an owned document.

Auto-detected file input supports libmandoc’s native gzip handling and zstd files. .so expansion is governed by IncludePolicy.

Errors

Returns ParseError when the path cannot be represented for C, the source cannot be read or decoded, or libmandoc rejects the source.

pub fn parse_bytes( &self, source_path: impl AsRef<Path>, source: &[u8], ) -> Result<ParseReport, ParseError>

Parse caller-owned source bytes under a logical source path.

Byte input is useful when a caller owns its transport or decompression layer. In auto mode zstd magic is recognized; gzip byte input should use Parser::parse_file so libmandoc can open it natively.

Errors

Returns ParseError when the logical path is invalid, the requested zstd decoding fails, or libmandoc rejects the supplied roff bytes.

Trait Implementations

impl Clone for Parser

fn clone(&self) -> Parser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Parser

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

Formats the value using the given formatter.

impl Default for Parser

fn default() -> Parser

Returns the “default value” for a type.

impl Eq for Parser

impl PartialEq for Parser

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Parser