Struct Cache 

pub struct Cache {
    pub entries: HashMap<String, (u8, u8, u8)>,
}

Allows caching extraction results.

Using cache improves performance a lot, so it is recommended to use. First time you extract color from the image, it can take a bit longer, since just opening a high resolution image takes a bit of time. To improve this, the extracted color is stored in the cache (when used), so the next time you want to extract color from the same image, it is pretty much instant.

Usage

Generaly you don’t need to use the cache directly, you can use the specific Extractor methods:

• Extractor::extract_cached
• `Extractor::extract_cached_with_progress

Fields

entries: HashMap<String, (u8, u8, u8)>

Implementations

impl Cache

pub fn load_default() -> Self

Loads the cache from the default cache file path.

Default cache file path is given by the Cache::file.

If it fails to load or find the cache file, it returns default cache.

pub fn load<P>(file: P) -> Self

where P: AsRef<Path>,

Loads the cache from the given file path.

If it fails to load or find the cache file, it returns default cache.

pub fn save_default(&self) -> Result<(), Error>

Saves the current cache to the default cache file path.

Default cache file path is given by the Cache::file.

pub fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the current cache to the given file path.

pub fn key<P>(config: &ExtractionConfig, image: P) -> Result<String, Error>

where P: AsRef<Path>,

Generates the cache key for the given config and image.

This is done so that any change in config, that would effect the extracted color, is detected. It also can detect the image being modified.

pub fn dir() -> PathBuf

Gets the default cache directory.

pub fn file() -> PathBuf

Gets the default cache file path.

It uses the Cache::dir to get the cache directory, followed by the colors.bin.

Trait Implementations

impl Clone for Cache

fn clone(&self) -> Cache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cache

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

Formats the value using the given formatter.

impl Default for Cache

fn default() -> Cache

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cache

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Cache

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

where __S: Serializer,

Serialize this value into the given Serde serializer.