Struct InnerCache

pub struct InnerCache { /* private fields */ }

A lazily connected connection to the cache database.

Examples

use url_cleaner_engine::glue::*;

// Note the mutability.
let mut cache = InnerCache::new(CachePath::Memory);


assert_eq!(cache.read("category", "key").unwrap(), None);
cache.write("category", "key", None).unwrap();
assert_eq!(cache.read("category", "key").unwrap(), Some(None));
cache.write("category", "key", Some("value")).unwrap();
assert_eq!(cache.read("category", "key").unwrap(), Some(Some("value".into())));

Implementations

impl InnerCache

pub fn new(path: CachePath) -> Self

Create a new unconnected Self.

impl InnerCache

pub fn path(&self) -> &CachePath

Gets the CachePath of the connection.

pub fn connection(&mut self) -> Option<&mut SqliteConnection>

Gets the connection itself, if self has been connected via Self::connect yet.

pub fn connect(&mut self) -> Result<&mut SqliteConnection, ConnectCacheError>

Returns the connection, connecting if not already connected.

Errors

If the call to std::fs::exists to check if the database exists returns an error, that error is returned.

If the call to std::fs::File::create_new to create the database returns an error, that error is returned.

If the call to SqliteConnection::establish to connect to the database returns an error, that error is returned.

If the call to SqlQuery::execute to initialize the database returns an error, that error is returned.

pub fn disconnect(&mut self)

Disconnects from the database.

pub fn read( &mut self, category: &str, key: &str, ) -> Result<Option<Option<String>>, ReadFromCacheError>

Reads from the database.

Errors

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

If the call to RunQueryDsl::load returns an error, that error is returned.

pub fn write( &mut self, category: &str, key: &str, value: Option<&str>, ) -> Result<(), WriteToCacheError>

Writes to the database, overwriting the entry the equivalent call to Self::read would return.

Errors

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

If the call to RunQueryDsl::get_result returns an error, that error is returned.

Trait Implementations

impl Debug for InnerCache

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

Formats the value using the given formatter.

impl Default for InnerCache

fn default() -> InnerCache

Returns the “default value” for a type.

impl From<CachePath> for InnerCache

fn from(value: CachePath) -> Self

Converts to this type from the input type.

impl From<InnerCache> for (CachePath, OnceCell<SqliteConnection>)

fn from(value: InnerCache) -> Self

Converts to this type from the input type.

impl From<InnerCache> for Cache

fn from(value: InnerCache) -> Self

Converts to this type from the input type.

impl PartialEq for InnerCache

fn eq(&self, other: &Self) -> 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 Eq for InnerCache