Struct libwebnovel_storage::LocalLibrary

pub struct LocalLibrary { /* private fields */ }

A local disk storage.

use tempfile::tempdir;
use libwebnovel_storage::LocalLibrary;

// Dummy path to a config file. If the path does not exist, a default configuration will be created
let config_path = "path/to/toml_config";

let mut library = LocalLibrary::load(config_path).unwrap();
// Add & download a given URL
library
    .add("https://www.royalroad.com/fiction/21220/mother-of-learning")
    .unwrap();
let novel_urls_list = library.list();
assert_eq!(novel_urls_list.len(), 1);
assert_eq!(
    &novel_urls_list[0].to_string(),
    "https://www.royalroad.com/fiction/21220/mother-of-learning"
);

Implementations

impl LocalLibrary

pub fn load(config_path: impl Into<PathBuf>) -> Result<Self, LibraryError>

Attempts to create a new Self from a config file.

use directories::BaseDirs;
use libwebnovel_storage::LocalLibrary;

let config_path = "path/to/config.toml";
let library = LocalLibrary::load(config_path).unwrap(); // If the path doesn't exist, a
                                                        // default configuration will be
                                                        // loaded
// Get the default data directory on this platform
let basedirs = BaseDirs::new().unwrap();
let data_dir = basedirs.data_dir().join(env!["CARGO_PKG_NAME"]);
assert_eq!(library.base_path(), data_dir);

pub fn set_base_path( &mut self, base_path: impl Into<PathBuf> + AsRef<Path>, ) -> Result<(), LibraryError>

Changes the library base data path, moving existing content if necessary.

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

Saves the current config to disk.

use std::path::Path;

use libwebnovel_storage::LocalLibrary;

let config_path_str = "/tmp/libwebnovel/config.toml";
let config_path = Path::new(config_path_str);
let library = LocalLibrary::load(config_path_str.clone()).unwrap();

let config_path = Path::new(&config_path_str);
assert!(!config_path.exists());
library.persist().unwrap();
assert!(config_path.exists());

pub fn base_path(&self) -> &Path

Returns the base path of the library storage

pub fn add(&mut self, url: &str) -> Result<String, LibraryError>

Adds a new webnovel to watch. Won’t call [self.update()].

pub fn list(&self) -> Vec<Url>

Returns a list of webnovels currently watched

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

Updates all watched novels. If at least one error has been encountered during update.

pub fn remove(&mut self, url: &str) -> Result<(), LibraryError>

Removes a webnovel from the watchlist and deletes local content. If there are duplicates in the novels list, only the first found will be removed and deleted.

pub fn novels(&self) -> &Vec<Novel>

Returns a reference to the internal novels vector.

pub fn novels_mut(&mut self) -> &mut Vec<Novel>

Returns a mutable reference to the internal novels vector

Trait Implementations

impl Debug for LocalLibrary

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

Formats the value using the given formatter.

impl Default for LocalLibrary

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalLibrary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for LocalLibrary

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

where __S: Serializer,

Serialize this value into the given Serde serializer.