Skip to main content

Komer

Struct Komer 

Source
pub struct Komer<T>
where T: Serialize + for<'de> Deserialize<'de> + Debug,
{ /* private fields */ }
Expand description

Keyspace Object Mapper factory struct.

Implementations§

Source§

impl<T> Komer<T>
where T: Serialize + for<'de> Deserialize<'de> + Debug,

Source

pub fn new( db: Arc<LMDBer>, subkey: &str, kind: SerialKind, ) -> Result<Self, KomerError>

Creates a new Komer instance.

§Parameters
  • db - Base database reference
  • subkey - LMDB sub database key
  • kind - Serialization/deserialization type
§Returns

A Result containing the Komer instance or a KomerError

Source

pub fn put<K>(&self, keys: &[K], val: &T) -> Result<bool, KomerError>
where K: AsRef<[u8]>,

Puts val at key made from keys. Does not overwrite.

§Parameters
  • txn - Database transaction
  • keys - Key components to be combined to form the key
  • val - Value to store
§Returns

True if successful, False otherwise (e.g., if key already exists in database)

Source

pub fn pin<K>(&self, keys: &[K], val: &T) -> Result<bool, KomerError>
where K: AsRef<[u8]>,

Pins (sets) val at key made from keys. Overwrites existing value.

§Parameters
  • txn - Database transaction
  • keys - Key components to be combined to form the key
  • val - Value to store
§Returns

True if successful, False otherwise

Source

pub fn get<K>(&self, keys: &[K]) -> Result<Option<T>, KomerError>
where K: AsRef<[u8]>,

Gets val at keys.

§Parameters
  • txn - Database transaction
  • keys - Key components to be combined to form the key
§Returns

Option containing the value if found, None if no entry at keys

Source

pub fn get_json<K>(&self, keys: &[K]) -> Result<Option<Value>, KomerError>
where K: AsRef<[u8]>,

Gets dictified val at keys. In Rust, we’ll return a serde_json::Value instead of a dict.

§Parameters
  • txn - Database transaction
  • keys - Key components to be combined to form the key
§Returns

Option containing the value as JSON if found, None if no entry at keys

Source

pub fn get_item_iter<K>( &self, keys: &[K], ) -> Result<Vec<(Vec<String>, T)>, KomerError>
where K: AsRef<[u8]>,

Source

pub fn rem<K>(&self, keys: &[K]) -> Result<bool, KomerError>
where K: AsRef<[u8]>,

Removes entry at keys.

§Parameters
  • txn - Database transaction
  • keys - Key components to be combined to form the key
§Returns

True if key exists so delete successful, False otherwise

Source

pub fn trim<K>(&self, keys: &[K]) -> Result<bool, KomerError>
where K: AsRef<[u8]>,

Removes all entries whose keys starts with the given keys prefix. Enables removal of whole branches of db key space.

§Parameters
  • txn - Database transaction
  • keys - Key components to be combined to form the prefix
§Returns

True if operation successful, False otherwise

Source

pub fn cnt_all(&self) -> Result<usize, KomerError>

Return the count of all items in the subdatabase.

§Parameters
§Returns

Number of items in the database

Auto Trait Implementations§

§

impl<T> Freeze for Komer<T>

§

impl<T> RefUnwindSafe for Komer<T>
where T: RefUnwindSafe,

§

impl<T> Send for Komer<T>
where T: Send,

§

impl<T> Sync for Komer<T>
where T: Sync,

§

impl<T> Unpin for Komer<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Komer<T>

§

impl<T> UnwindSafe for Komer<T>
where T: 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.

§

impl<T> Instrument for T

§

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

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

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> 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

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

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