BibleLookup

Struct BibleLookup 

Source
pub struct BibleLookup {
    pub book: String,
    pub chapter: u32,
    pub verse: u32,
    pub thru_verse: Option<u32>,
}
Expand description

Struct representing a Bible verse lookup book is not case-sensitive thru_verse is optional and used for verse ranges like John 3:16-18

§Example

use bible_lib::{Bible, BibleLookup, Translation};

// get the bible translation
let bible = Bible::new(Translation::KingJames).unwrap();
// create a lookup for John 3:16
let lookup = BibleLookup::new("John", 3, 16);
// get the verse text
let verse = bible.get_verse(lookup, false).unwrap();

// print the verse text
println!("John 3:16: {}", verse);

Fields§

§book: String§chapter: u32§verse: u32§thru_verse: Option<u32>

Implementations§

Source§

impl BibleLookup

Source

pub fn new<S: Into<String>>(book: S, chapter: u32, verse: u32) -> Self

Create a new BibleLookup instance (single verse) book is not case-sensitive

§Example
use bible_lib::BibleLookup;

// create a lookup for John 3:16
let lookup = BibleLookup::new("John", 3, 16);
Source

pub fn new_range<S: Into<String>>( book: S, chapter: u32, verse: u32, thru_verse: u32, ) -> Self

Create a new BibleLookup instance (verse range)

§Example
use bible_lib::BibleLookup;

// create a lookup for Luke 23:39-43
let lookup = BibleLookup::new_range("Luke", 23, 39, 43);
Source

pub fn capitalize_book(name: &String) -> String

Capitalize the first letter of each word in the book name Handles cases like 1 samuel and song of solomon This is used because book names are stored in lowercase for easier lookup

§Example
use bible_lib::BibleLookup;

// capitalize book names
let book1 = BibleLookup::capitalize_book(&"john".to_string());
let book2 = BibleLookup::capitalize_book(&"1 samuel".to_string());

// print the capitalized book names
println!("Capitalized Book 1: {}", book1); // John
println!("Capitalized Book 2: {}", book2); // 1 Samuel

Trait Implementations§

Source§

impl Clone for BibleLookup

Source§

fn clone(&self) -> BibleLookup

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BibleLookup

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for BibleLookup

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for BibleLookup

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Eq for BibleLookup

Source§

impl StructuralPartialEq for BibleLookup

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V