Struct BibleChapterRange 

pub struct BibleChapterRange { /* private fields */ }

A Bible Chapter range is a range of Bible chapters, e.g. Genesis 1 to Genesis 2. It is represented by two BibleChapterReferences. The first chapter is the start of the range and the second chapter is the end of the range.

Implementations

impl BibleChapterRange

pub fn new( start: BibleChapterReference, end: BibleChapterReference, ) -> Result<Self, BibleReferenceValidationError>

Creates a new BibleChapterRange with the given start and end chapters, if the start chapter is before the end chapter. If the start chapter is after the end chapter, an error will be returned.

Parameters

• start: The start of the range
• end: The end of the range

pub fn start(&self) -> BibleChapterReference

Returns the start of the range

pub fn end(&self) -> BibleChapterReference

Returns the end of the range

pub fn as_list(&self) -> BibleChapterList

Returns the range as a BibleChapterList

pub fn as_verse_range(&self) -> BibleVerseRange

Downcasts the BibleChapterRange to a BibleVerseRange The first verse for the start chapter is assumed, and the last verse for the end chapter is assumed.

pub fn as_book_range(&self) -> Option<BibleBookRange>

Tries to convert the range into a BibleBookRange if the range spans multiple books completely. Returns None if the range does not span over multiple books.

pub fn as_single_chapter(&self) -> Option<BibleChapterReference>

Converts the range into a BibleChapterReference if the range spans a single chapter. Returns None if the range does not span over a single chapter.

Trait Implementations

impl Clone for BibleChapterRange

fn clone(&self) -> BibleChapterRange

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BibleChapterRange

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

Formats the value using the given formatter.

impl Eq for BibleChapterRange

impl Ord for BibleChapterRange

fn cmp(&self, other: &BibleChapterRange) -> 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 BibleChapterRange

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for BibleChapterRange

fn partial_cmp(&self, other: &BibleChapterRange) -> 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 BibleChapterRange