Store

Struct Store 

Source
pub struct Store<B: StoreBackend> { /* private fields */ }
Expand description

Simple Flash Key Value Store

Implementations§

Source§

impl<B: StoreBackend> Store<B>

Source

pub fn new(backend: B) -> Self

wrap a StoreBackend into a store

Source

pub fn read(&self, key: &str) -> Result<Option<&[u8]>, ReadError>

read from key

Source

pub fn read_str(&self, key: &str) -> Result<Option<&str>, ReadError>

read from key, decode UTF-8

Source

pub fn read_value<'a, T: Deserialize<'a>>( &'a self, key: &str, ) -> Result<Option<T>, Error<B::Error>>

read from key, decode with postcard

Source

pub fn get_bytes_used(&self) -> Result<usize, ReadError>

how many bytes are currently used

equally, offset of free space

Source

pub fn write<V: AsRef<[u8]>>( &mut self, key: &str, value: V, ) -> Result<(), Error<B::Error>>

store a buffer value at key

Source

pub fn write_value<T, V>( &mut self, key: &str, value: &T, value_buf: V, ) -> Result<(), Error<B::Error>>
where T: Serialize, V: AsMut<[u8]>,

encode with postcard, write at key

Source

pub fn remove(&mut self, key: &str) -> Result<(), Error<B::Error>>

store a 0-byte tombstone value at key

Source

pub fn erase(&mut self) -> Result<(), WriteError<B::Error>>

invokes erase on the backend (this is no compaction!)

Auto Trait Implementations§

§

impl<B> Freeze for Store<B>
where B: Freeze,

§

impl<B> RefUnwindSafe for Store<B>
where B: RefUnwindSafe,

§

impl<B> Send for Store<B>
where B: Send,

§

impl<B> Sync for Store<B>
where B: Sync,

§

impl<B> Unpin for Store<B>
where B: Unpin,

§

impl<B> UnwindSafe for Store<B>
where B: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.