Struct Cleaner

pub struct Cleaner {
    pub docs: CleanerDocs,
    pub cache_path: CachePath,
    pub params: Params,
    pub commons: Commons,
    pub actions: Vec<Action>,
}

The config that determines all behavior of how URLs are cleaned.

Fields

docs: CleanerDocs

The documentation.

Defaults to an empty CleanerDocs.

cache_path: CachePath

The location of the cache.

Defaults to being stored in memory and destroyed on program exit.

params: Params

Fine tuning shared between all Tasks of a Job and maybe multiple Jobs.

Defaults to an empty Params.

commons: Commons

Basically functions.

Defaults to an empty Commons.

actions: Vec<Action>

The Actions to apply.

Defaults to an empty Vec.

Implementations

impl Cleaner

pub fn load_from_file<T: AsRef<Path>>(path: T) -> Result<Self, GetCleanerError>

Load Self from a JSON file.

Errors

If the call to std::fs::read_to_string returns an error, that error is returned.

If the call to serde_json::from_str returns an error, that error is returned.

pub fn get_default() -> Result<&'static Self, GetCleanerError>

Gets the default Self compiled into the binary itself.

Caching is done by putting the Self in DEFAULT_CLEANER and only returning references to it.

If you know you’re only going to get the default config once, Self::get_default_no_cache is better because you can apply ParamsDiffs to it without Clone::cloneing.

Errors

If the call to Self::get_default_no_cache returns an error, that error is returned.

Examples

use url_cleaner_engine::types::*;

Cleaner::get_default().unwrap();

pub fn get_default_no_cache() -> Result<Self, GetCleanerError>

Deserializes DEFAULT_CLEANER_STR and returns it without caching in DEFAULT_CLEANER

If you’re getting the default config often and rarely using ParamsDiffs, Self::get_default may be better due to it only deserializing the config once.

Errors

If the call to serde_json::from_str returns an error, that error is returned.

Examples

use url_cleaner_engine::types::*;

Cleaner::get_default_no_cache().unwrap();

pub fn load_or_get_default<T: AsRef<Path>>( path: Option<T>, ) -> Result<Cow<'static, Self>, GetCleanerError>

If path is Some, returns the result of Self::load_from_file in a Cow::Owned.

If path is None, returns the result of Self::get_default in a Cow::Borrowed.

Errors

If the call to Self::load_from_file returns an error, that error is returned.

If the call to Self::get_default returns an error, that error is returned.

Examples

use url_cleaner_engine::types::*;

assert_eq!(
    Cleaner::get_default().unwrap(),
    &*Cleaner::load_or_get_default(None::<&str>).unwrap()
);

assert_eq!(
    Cleaner::get_default().unwrap(),
    &*Cleaner::load_or_get_default(Some("default-cleaner.json")).unwrap()
);

pub fn load_or_get_default_no_cache<T: AsRef<Path>>( path: Option<T>, ) -> Result<Self, GetCleanerError>

If path is Some, returns the result of Self::load_from_file.

If path is None, returns the result of Self::get_default_no_cache.

Errors

If the call to Self::load_from_file returns an error, that error is returned.

If the call to Self::get_default returns an error, that error is returned.

Examples

use url_cleaner_engine::types::*;

assert_eq!(
    Cleaner::get_default_no_cache().unwrap(),
    Cleaner::load_or_get_default_no_cache(None::<&str>).unwrap()
);

assert_eq!(
    Cleaner::get_default_no_cache().unwrap(),
    Cleaner::load_or_get_default_no_cache(Some("default-cleaner.json")).unwrap()
);

pub fn apply( &self, job_state: &mut TaskState<'_>, ) -> Result<(), ApplyCleanerError>

Applies each Action in Self::actions in order to the provided TaskState.

If an error is returned, job_state may be left in a partially modified state.

Errors

If any call to Action::apply returns an error, that error is returned.

pub fn run_tests(&self, tests: Tests)

Runs the provided Tests, panicking if any of them fail.

Panics

If any Test fails, panics.

pub fn assert_suitability(&self)

Asserts the suitability of self to be URL Cleaner’s default config.

Exact behavior is unspecified and changes are not considered breaking.

Panics

If self is deemed unsuitable to be URL Cleaner’s default config, panics.

Examples

use url_cleaner_engine::types::*;

Cleaner::get_default().unwrap().assert_suitability();

Trait Implementations

impl Clone for Cleaner

fn clone(&self) -> Cleaner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cleaner

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

Formats the value using the given formatter.

impl Default for Cleaner

fn default() -> Cleaner

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cleaner

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Cleaner

fn eq(&self, other: &Cleaner) -> 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 Serialize for Cleaner

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Cleaner

impl StructuralPartialEq for Cleaner