Struct ReferenceParser 

pub struct ReferenceParser { /* private fields */ }

A reusable parser with immutable alias and ambiguity configuration.

Implementations

impl ReferenceParser

pub fn new() -> ReferenceParser

Construct a parser with bundled aliases and automatic detection.

pub fn builder() -> ParserBuilder

Start configuring a parser.

pub fn preferred_languages(&self) -> &[Language]

Return configured preferred languages.

pub fn aliases(&self) -> impl Iterator<Item = (&str, Book)>

Iterate over configured language-neutral aliases in registration order.

pub fn aliases_by_language( &self, ) -> impl Iterator<Item = (Language, &str, Book)>

Iterate over configured language-specific aliases in registration order.

pub const fn ambiguity_policy(&self) -> AmbiguityPolicy

Return this parser’s ambiguity policy.

pub fn parse(&self, input: &str) -> Result<Reference, ParseError>

Parse a single verse or an inclusive range using automatic detection.

pub fn parse_with_language( &self, input: &str, language: Language, ) -> Result<Reference, ParseError>

Parse a reference using one explicit language.

pub fn parse_detailed( &self, input: &str, ) -> Result<Parsed<Reference>, ParseError>

Parse a reference and retain normalization and language metadata.

pub fn parse_detailed_with_language( &self, input: &str, language: Language, ) -> Result<Parsed<Reference>, ParseError>

Parse with an explicit language and retain metadata.

pub fn try_parse(&self, input: &str) -> Option<Reference>

Return None rather than an error for invalid input.

pub fn try_parse_with_language( &self, input: &str, language: Language, ) -> Option<Reference>

Parse with an explicit language, returning None for invalid input.

pub fn parse_book(&self, input: &str) -> Result<Book, ParseError>

Resolve a standalone book token using automatic language detection.

pub fn parse_book_with_language( &self, input: &str, language: Language, ) -> Result<Book, ParseError>

Resolve a standalone book token using an explicit language.

pub fn parse_book_detailed( &self, input: &str, ) -> Result<Parsed<Book>, ParseError>

Resolve a standalone book token and retain detection metadata.

pub fn parse_book_detailed_with_language( &self, input: &str, language: Language, ) -> Result<Parsed<Book>, ParseError>

Resolve a standalone book token with an explicit language and metadata.

pub fn parse_verse(&self, input: &str) -> Result<VerseRef, ParseError>

Parse only a single verse.

pub fn parse_verse_with_language( &self, input: &str, language: Language, ) -> Result<VerseRef, ParseError>

Parse only a single verse with an explicit language.

pub fn parse_verse_detailed( &self, input: &str, ) -> Result<Parsed<VerseRef>, ParseError>

Parse only a single verse and retain detection metadata.

pub fn parse_verse_detailed_with_language( &self, input: &str, language: Language, ) -> Result<Parsed<VerseRef>, ParseError>

Parse only a single verse with an explicit language and metadata.

pub fn try_parse_verse(&self, input: &str) -> Option<VerseRef>

Parse only a single verse, returning None for invalid input.

pub fn try_parse_verse_with_language( &self, input: &str, language: Language, ) -> Option<VerseRef>

Parse only a single verse with an explicit language, returning None for invalid input.

pub fn parse_range(&self, input: &str) -> Result<VerseRange, ParseError>

Parse only a range.

pub fn parse_range_with_language( &self, input: &str, language: Language, ) -> Result<VerseRange, ParseError>

Parse only a range with an explicit language.

pub fn parse_range_detailed( &self, input: &str, ) -> Result<Parsed<VerseRange>, ParseError>

Parse only a range and retain detection metadata.

pub fn parse_range_detailed_with_language( &self, input: &str, language: Language, ) -> Result<Parsed<VerseRange>, ParseError>

Parse only a range with an explicit language and metadata.

pub fn try_parse_range(&self, input: &str) -> Option<VerseRange>

Parse only a range, returning None for invalid input.

pub fn try_parse_range_with_language( &self, input: &str, language: Language, ) -> Option<VerseRange>

Parse only a range with an explicit language, returning None for invalid input.

Trait Implementations

impl Clone for ReferenceParser

fn clone(&self) -> ReferenceParser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceParser

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

Formats the value using the given formatter.

impl Default for ReferenceParser

fn default() -> ReferenceParser

Returns the “default value” for a type.