Struct PassageParser 

pub struct PassageParser { /* private fields */ }

A reusable parser for book, chapter, verse-list, and passage sequences.

Implementations

impl PassageParser

pub fn new() -> PassageParser

Construct a parser with bundled aliases and conventional shorthand.

pub fn from_reference_parser(reference_parser: ReferenceParser) -> PassageParser

Construct a passage parser around an existing reference parser.

pub fn with_single_chapter_books( self, books: impl IntoIterator<Item = Book>, ) -> PassageParser

Replace the books for which a bare number denotes a chapter-one verse.

pub const fn reference_parser(&self) -> &ReferenceParser

Borrow the parser used for book-name resolution and reference parsing.

pub fn single_chapter_books(&self) -> &[Book]

Return the books configured for bare-number verse shorthand.

pub fn is_single_chapter_book(&self, book: Book) -> bool

Whether a book uses bare-number verse shorthand in this parser.

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

Parse a passage using automatic language detection.

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

Parse a passage using one explicit book-name language.

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

Parse a passage and retain normalization and book-resolution metadata.

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

Parse with an explicit language and retain resolution metadata.

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

Return None rather than an error for invalid input.

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

Return None rather than an error when parsing with one language.

Trait Implementations

impl Clone for PassageParser

fn clone(&self) -> PassageParser

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PassageParser

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

Formats the value using the given formatter.

impl Default for PassageParser

fn default() -> PassageParser

Returns the “default value” for a type.