Struct ReferenceExtractor 

pub struct ReferenceExtractor { /* private fields */ }

Finds parseable Bible passages embedded in arbitrary prose.

Results are returned from left to right, never overlap, and prefer the longest successful parse beginning at a given byte offset.

Implementations

impl ReferenceExtractor

pub fn new() -> ReferenceExtractor

Construct an extractor with a default PassageParser.

pub fn builder() -> ReferenceExtractorBuilder

Start configuring an extractor.

pub fn from_parser(parser: PassageParser) -> ReferenceExtractor

Construct an extractor around an existing parser.

pub fn with_options( parser: PassageParser, include_bare_books: bool, max_lookbehind: usize, max_lookahead: usize, ) -> Result<ReferenceExtractor, ExtractorConfigError>

Construct an extractor from validated configuration values.

pub const fn parser(&self) -> &PassageParser

Return the parser used to validate candidate spans.

pub const fn include_bare_books(&self) -> bool

Return whether whole-book passages are included.

pub const fn max_lookbehind(&self) -> usize

Return the normalized-byte search distance before numeric anchors.

pub const fn max_lookahead(&self) -> usize

Return the normalized-byte search distance after numeric anchors.

pub fn with_include_bare_books(self, include: bool) -> ReferenceExtractor

Return a copy configured to include or exclude whole-book passages.

pub fn with_max_lookbehind( self, value: usize, ) -> Result<ReferenceExtractor, ExtractorConfigError>

Return a copy with a validated lookbehind window.

pub fn with_max_lookahead( self, value: usize, ) -> Result<ReferenceExtractor, ExtractorConfigError>

Return a copy with a validated lookahead window.

pub fn extract(&self, source: &str) -> Vec<PassageMatch>

Find deterministic, non-overlapping passages in source.

pub fn extract_with_language( &self, source: &str, language: Language, ) -> Vec<PassageMatch>

Find passages while resolving book names in one explicit language.

pub fn find_all(&self, source: &str) -> Vec<PassageMatch>

Alias for Self::extract.

pub fn find_all_with_language( &self, source: &str, language: Language, ) -> Vec<PassageMatch>

Language-specific alias for Self::extract_with_language.

pub fn replace_matches<F, R>(&self, source: &str, replacement: F) -> String

where F: FnMut(&PassageMatch) -> R, R: Display,

Replace all matches in one pass without scanning replacement text.

pub fn replace_matches_with_language<F, R>( &self, source: &str, language: Language, replacement: F, ) -> String

where F: FnMut(&PassageMatch) -> R, R: Display,

Replace language-specific matches in one pass.

pub fn linkify<F, R>(&self, source: &str, link_builder: F) -> String

where F: FnMut(&PassageMatch) -> R, R: Display,

Linkify matches with a caller-provided renderer.

pub fn linkify_with_language<F, R>( &self, source: &str, language: Language, link_builder: F, ) -> String

where F: FnMut(&PassageMatch) -> R, R: Display,

Linkify matches resolved with one explicit language.

pub fn linkify_markdown<F, U>(&self, source: &str, uri_builder: F) -> String

where F: FnMut(&PassageMatch) -> U, U: Display,

Linkify matches as Markdown using each exact source slice as its label.

pub fn linkify_markdown_with_language<F, U>( &self, source: &str, language: Language, uri_builder: F, ) -> String

where F: FnMut(&PassageMatch) -> U, U: Display,

Linkify explicitly localized matches as Markdown using exact source labels.

pub fn linkify_markdown_with_label<F, U, L>( &self, source: &str, uri_builder: F, label_builder: L, ) -> String

where F: FnMut(&PassageMatch) -> U, U: Display, L: FnMut(&PassageMatch) -> String,

Linkify matches as Markdown with caller-provided labels and destinations.

pub fn linkify_markdown_with_label_and_language<F, U, L>( &self, source: &str, language: Language, uri_builder: F, label_builder: L, ) -> String

where F: FnMut(&PassageMatch) -> U, U: Display, L: FnMut(&PassageMatch) -> String,

Linkify explicitly localized matches with custom Markdown labels.

pub fn markdown_linkify<F, U>(&self, source: &str, uri_builder: F) -> String

where F: FnMut(&PassageMatch) -> U, U: Display,

Alias for Self::linkify_markdown.

pub fn markdown_linkify_with_language<F, U>( &self, source: &str, language: Language, uri_builder: F, ) -> String

where F: FnMut(&PassageMatch) -> U, U: Display,

Language-specific alias for Self::linkify_markdown_with_language.

Trait Implementations

impl Clone for ReferenceExtractor

fn clone(&self) -> ReferenceExtractor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReferenceExtractor

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

Formats the value using the given formatter.

impl Default for ReferenceExtractor

fn default() -> ReferenceExtractor

Returns the “default value” for a type.