Struct ChapterPassage 

pub struct ChapterPassage { /* private fields */ }

A passage covering one chapter or an inclusive range of chapters.

Implementations

impl ChapterPassage

pub const fn new( book: Book, start_chapter: u16, end_chapter: Option<u16>, ) -> Result<ChapterPassage, PassageBuildError>

Construct a validated chapter or chapter-range passage.

pub const fn single( book: Book, chapter: u16, ) -> Result<ChapterPassage, PassageBuildError>

Construct a validated single-chapter passage.

pub const fn range( book: Book, start_chapter: u16, end_chapter: u16, ) -> Result<ChapterPassage, PassageBuildError>

Construct a validated inclusive chapter range.

pub const fn book(self) -> Book

Return the represented book.

pub const fn start_chapter(self) -> u16

Return the first represented chapter.

pub const fn end_chapter(self) -> Option<u16>

Return the inclusive last chapter for a range, or None for one chapter.

Trait Implementations

impl Clone for ChapterPassage

fn clone(&self) -> ChapterPassage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ChapterPassage

impl Debug for ChapterPassage

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

Formats the value using the given formatter.

impl Display for ChapterPassage

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

Formats the value using the given formatter.

impl Eq for ChapterPassage

impl From<ChapterPassage> for Passage

fn from(passage: ChapterPassage) -> Passage

Converts to this type from the input type.

impl Hash for ChapterPassage

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 ChapterPassage

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 ChapterPassage

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ChapterPassage