Enum Reference 

pub enum Reference {
    Verse(VerseRef),
    Range(VerseRange),
}

A single verse or a contiguous inclusive verse range.

Variants

Verse(VerseRef)

A single verse.

Range(VerseRange)

A contiguous inclusive range.

Implementations

impl Reference

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

Parse a reference with an explicit book-name language.

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

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

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

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

pub const fn start(self) -> VerseRef

Return the first verse represented by this value.

pub const fn end(self) -> VerseRef

Return the last verse represented by this value.

pub const fn as_verse(self) -> Option<VerseRef>

Return the inner verse when this is a single-verse reference.

pub const fn as_range(self) -> Option<VerseRange>

Return the inner range when this is a range reference.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Reference

impl Debug for Reference

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

Formats the value using the given formatter.

impl Display for Reference

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

Formats the value using the given formatter.

impl Eq for Reference

impl From<VerseRange> for Reference

fn from(value: VerseRange) -> Reference

Converts to this type from the input type.

impl From<VerseRef> for Reference

fn from(value: VerseRef) -> Reference

Converts to this type from the input type.

impl FromStr for Reference

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for Reference

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 Reference

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 PartialEq for Reference

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Reference