Struct Novel 

pub struct Novel { /* private fields */ }

Represents a novel. Stored on disk at the following path: <base_library_path>/<novel.title()>/

TODO: Detect remote novel title changes

Implementations

impl Novel

pub fn new( url: impl Into<Url>, library_path: &Path, ) -> Result<Self, LibraryError>

Returns a new Novel from the given URL. Functionally equivalent to [Novel::try_from(Url)].

pub fn url(&self) -> &Url

Returns the url of the novel

pub fn title(&self) -> Result<String, LibraryError>

Returns the title of the novel

pub fn get_chapter_storage_path(novel_path: &Path) -> PathBuf

returns where all the chapters are stored. static alternative to [self.chapter_storage_path()].

pub fn get_cover_storage_path(novel_path: &Path) -> PathBuf

returns where the cover image is stored. static alternative to [self.cover_storage_path].

pub fn chapter_storage_path(&self) -> PathBuf

Returns where all the chapters are stored. Alternative to the static Self::get_chapter_storage_path.

pub fn cover_storage_path(&self) -> PathBuf

Returns where the cover image is stored. Alternative to the static Self::get_cover_storage_path.

pub fn download_cover(&self) -> Result<(), LibraryError>

Downloads the cover file and places it in [self.cover_image_path], performing appropriate image format conversions if necessary.

pub fn update(&mut self) -> Result<(), LibraryError>

Fetch remote chapters & saves them locally. Will attempt to fix duplicates, ordering, and detect collisions.

pub fn consolidate_chapter_collection(&mut self)

Sorts, dedups and tries to fix chapter indexes in the current “live” chapter list.

pub fn update_iter(&mut self) -> NovelChapterUpdateIter<'_>

Returns an iterator that will fetch the chapters, returning a Result for each operation. See NovelChapterUpdateIter::next for more info. Will not attempt to handle duplicates & other stuff.

Panics

Panics when:

• [self.get_missing_chapters_indexes] panics

pub fn get_missing_chapters_indexes(&self) -> Result<Vec<usize>, LibraryError>

Returns chapter indexes that are present in the source but not locally.

pub fn get_local_chapter_count(&self) -> Result<usize, LibraryError>

Returns the count of locally-saved chapters

pub fn get_remote_chapter_count(&self) -> Result<usize, LibraryError>

returns the total count of remote chapters

pub fn load_local_chapters(&mut self) -> Result<(), LibraryError>

Loads local chapters and saves them in self.chapters. Overrides any currently loaded chapters.

pub fn get_local_chapters(&self) -> Result<Vec<Chapter>, LibraryError>

Returns a vector of all local Chapter.

pub fn novel_path(&self) -> &Path

Returns the root path of where this novel stores its files.

pub fn generate_epub(&self) -> Result<PathBuf, EpubGenerationError>

Generates an epub from this novel and its currently loaded chapters, returning the path it has been saved to.

Trait Implementations

impl Clone for Novel

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Novel

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Novel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Novel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Url> for Novel

fn try_from(value: Url) -> Result<Self, Self::Error>

WARNING: returns an uninitialized Novel.path!

type Error = LibraryError

The type returned in the event of a conversion error.