Skip to main content

Store

Struct Store 

Source
pub struct Store { /* private fields */ }
Expand description

An open redb database shared by a RedbCache and a RedbQueue.

Cloning is cheap (an Arc handle over one redb::Database), so Self::cache / Self::queue hand out independent wrappers sharing the same underlying database.

Store::in_memory opens an ephemeral database, so this example is fully runnable with no filesystem access. Share one Store between a crate::SimbadResolver (via crate::CacheBackend::custom) and a crate::BatchResolver to have both operate over the same rows.

use simbad_resolver::Store;

let store = Store::in_memory()?;
let cache = store.cache(); // implements `Cache`
let queue = store.queue(); // implements `Queue`

Implementations§

Source§

impl Store

Source

pub fn open(path: impl AsRef<Path>) -> Result<Self, CacheError>

Open (creating if missing) a durable, file-backed store at path, with the default BatchDurability::Durable bulk-load policy — exactly today’s behavior. See Store::open_with to opt into BatchDurability::Eventual batch loads.

§Errors

Returns CacheError::Backend if the database cannot be opened or its tables cannot be initialised.

use simbad_resolver::Store;

let path = std::env::temp_dir().join("simbad-resolver-doctest-store-open.redb");
let store = Store::open(&path)?; // creates the file if missing
assert!(path.exists());
Source

pub fn open_with( path: impl AsRef<Path>, bulk_durability: BatchDurability, ) -> Result<Self, CacheError>

Like Store::open, but configuring the BatchDurability every Cache::upsert_batch call against this store uses.

§Errors

Returns CacheError::Backend if the database cannot be opened or its tables cannot be initialised.

Source

pub fn in_memory() -> Result<Self, CacheError>

Open a fresh, ephemeral in-memory store (nothing persisted to disk), with the default BatchDurability::Durable bulk-load policy.

BatchDurability::Eventual only matters for a file-backed store (there’s no “reopen after a crash” scenario for an in-memory one), so unlike Store::open this has no _with variant; add one if that changes.

§Errors

Returns CacheError::Backend if the in-memory database cannot be created or its tables cannot be initialised.

Source

pub fn cache(&self) -> RedbCache

A RedbCache over this store’s database, inheriting its configured BatchDurability.

Source

pub fn queue(&self) -> RedbQueue

A RedbQueue over this store’s database.

Trait Implementations§

Source§

impl Clone for Store

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Store

§

impl !UnwindSafe for Store

§

impl Freeze for Store

§

impl Send for Store

§

impl Sync for Store

§

impl Unpin for Store

§

impl UnsafeUnpin for Store

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more