Struct VerseRef 

pub struct VerseRef { /* private fields */ }

A single Bible verse coordinate.

Implementations

impl VerseRef

pub const fn new( book: Book, chapter: u16, verse: u16, ) -> Result<VerseRef, CoordinateError>

Construct a validated verse coordinate.

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

Parse a verse with an optional explicit book-name language.

pub fn try_parse(input: &str) -> Option<VerseRef>

Parse a verse, returning None instead of an error for invalid input.

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

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

pub const fn book(self) -> Book

Return the book.

pub const fn chapter(self) -> u16

Return the one-based chapter.

pub const fn verse(self) -> u16

Return the one-based verse.

pub const fn with_book(self, book: Book) -> VerseRef

Return a copy with a different book.

pub const fn with_chapter( self, chapter: u16, ) -> Result<VerseRef, CoordinateError>

Return a validated copy with a different chapter.

pub const fn with_verse(self, verse: u16) -> Result<VerseRef, CoordinateError>

Return a validated copy with a different verse.

Trait Implementations

impl Clone for VerseRef

fn clone(&self) -> VerseRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for VerseRef

impl Debug for VerseRef

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

Formats the value using the given formatter.

impl Display for VerseRef

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

Formats the value using the given formatter.

impl Eq for VerseRef

impl From<VerseRef> for Reference

fn from(value: VerseRef) -> Reference

Converts to this type from the input type.

impl FromStr for VerseRef

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<VerseRef, <VerseRef as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for VerseRef

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 MachineIdentifiers for VerseRef

fn osis_identifier(&self) -> String

Encode this value as a case-sensitive OSIS identifier.

fn usfm_identifier(&self) -> String

Encode this value as a case-sensitive USFM identifier.

impl Ord for VerseRef

fn cmp(&self, other: &VerseRef) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for VerseRef

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for VerseRef

fn partial_cmp(&self, other: &VerseRef) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for VerseRef