Struct ReferenceFormatter 

pub struct ReferenceFormatter { /* private fields */ }

Immutable options for localized reference and passage formatting.

The default formatter uses English long book names and compact ranges. A language without bundled names falls back to English deterministically.

Implementations

impl ReferenceFormatter

pub const DEFAULT: ReferenceFormatter

The default English, long-name, compact-range formatter.

pub const fn new() -> ReferenceFormatter

Construct a formatter with the package defaults.

pub const fn with_options( language: Language, book_name_style: BookNameStyle, compact_ranges: bool, ) -> ReferenceFormatter

Construct a formatter from all configuration values.

pub const fn for_language(language: Language) -> ReferenceFormatter

Construct a formatter for one language, retaining the other defaults.

pub const fn language(self) -> Language

Return the requested output language.

pub const fn book_name_style(self) -> BookNameStyle

Return the configured book-name style.

pub const fn compact_ranges(self) -> bool

Return whether repeated components are omitted from ranges and lists.

pub const fn with_language(self, language: Language) -> ReferenceFormatter

Return a copy configured for language.

pub const fn with_book_name_style( self, book_name_style: BookNameStyle, ) -> ReferenceFormatter

Return a copy configured to use book_name_style.

pub const fn with_compact_ranges( self, compact_ranges: bool, ) -> ReferenceFormatter

Return a copy configured to compact or expand repeated range components.

pub fn book_name(self, book: Book) -> &'static str

Return the preferred localized display name for book.

pub fn format_book_name(self, book: Book) -> &'static str

Alias for Self::book_name matching the Dart package terminology.

pub const fn format_book(self, book: Book) -> FormattedBook

Wrap a book in a lazily evaluated fmt::Display adapter.

pub fn format(self, reference: impl Into<Reference>) -> FormattedReference

Wrap a verse or verse range in a localized fmt::Display adapter.

pub fn format_reference( self, reference: impl Into<Reference>, ) -> FormattedReference

Wrap a verse or verse range in a localized fmt::Display adapter.

pub const fn format_passage<'a>( self, passage: &'a Passage, ) -> FormattedPassage<'a>

Wrap a whole passage expression in a localized fmt::Display adapter.

pub const fn format_book_passage( self, passage: BookPassage, ) -> FormattedBookPassage

Wrap a whole-book passage in a localized fmt::Display adapter.

pub const fn format_chapter_passage( self, passage: ChapterPassage, ) -> FormattedChapterPassage

Wrap a chapter passage in a localized fmt::Display adapter.

pub const fn format_verse_passage<'a>( self, passage: &'a VersePassage, ) -> FormattedVersePassage<'a>

Wrap a verse-selection passage in a localized fmt::Display adapter.

pub const fn format_passage_sequence<'a>( self, passage: &'a PassageSequence, ) -> FormattedPassageSequence<'a>

Wrap a passage sequence in a localized fmt::Display adapter.

Trait Implementations

impl Clone for ReferenceFormatter

fn clone(&self) -> ReferenceFormatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ReferenceFormatter

impl Debug for ReferenceFormatter

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

Formats the value using the given formatter.

impl Default for ReferenceFormatter

fn default() -> ReferenceFormatter

Returns the “default value” for a type.

impl Eq for ReferenceFormatter

impl From<Language> for ReferenceFormatter

fn from(language: Language) -> ReferenceFormatter

Converts to this type from the input type.

impl Hash for ReferenceFormatter

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ReferenceFormatter

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ReferenceFormatter