Skip to main content

OnSuberBase

Struct OnSuberBase 

Source
pub struct OnSuberBase<C: ValueCodec = Utf8Codec> {
    pub base: SuberBase<C>,
}

Fields§

§base: SuberBase<C>

Implementations§

Source§

impl<C: ValueCodec> OnSuberBase<C>

Source

pub fn new( db: Arc<LMDBer>, subkey: &str, sep: Option<u8>, verify: bool, dupsort: Option<bool>, ) -> Result<Self, SuberError>

Creates a new OnSuberBase.

§Parameters
  • db - The base database (LMDBer)
  • subkey - LMDB sub database key
  • sep - Separator to convert keys iterator to key bytes for db key. Default ‘.’
  • verify - Whether to reverify when ._des from db when applicable. Default false
  • dupsort - Whether to enable duplicates at each key. Default false
Source

pub fn is_dupsort(&self) -> bool

Returns whether duplicates are enabled at each key

Source

pub fn _tokey<K: AsRef<[u8]>>(&self, keys: &[K]) -> Vec<u8> ⓘ

Converts a collection of keys to a single key byte vector

Source

pub fn _tokeys(&self, key: &[u8]) -> Vec<Vec<u8>>

Converts a key byte vector to a collection of keys

Source

pub fn _ser<T: ?Sized + Clone + Into<Vec<u8>>>( &self, val: &T, ) -> Result<Vec<u8>, SuberError>

Serializes a value

Source

pub fn _des<T: TryFrom<Vec<u8>>>(&self, val: &[u8]) -> Result<T, SuberError>

Deserializes a value

Source

pub fn put_on<K: AsRef<[u8]>, V: ?Sized + Clone + Into<Vec<u8>>>( &self, keys: &[K], on: u32, val: &V, ) -> Result<bool, SuberError>

Puts a value at a key with an ordinal number

§Returns
  • true if the onkey made from key+sep+serialized on is not found in database so value is written idempotently
  • false otherwise
§Parameters
  • keys - Keys as prefix to be combined with serialized on suffix and sep to form onkey
  • on - Ordinal number used to form key
  • val - Serialization
Source

pub fn pin_on<K: AsRef<[u8]>, V: ?Sized + Clone + Into<Vec<u8>>>( &self, keys: &[K], on: u32, val: &V, ) -> Result<bool, SuberError>

Sets or overwrites a value at a key with an ordinal number

§Returns
  • true if value is written or overwritten at onkey
  • false otherwise
§Parameters
  • keys - Keys as prefix to be combined with serialized on suffix and sep to form onkey
  • on - Ordinal number used to form key
  • val - Serialization
Source

pub fn append_on<K: AsRef<[u8]>, V: ?Sized + Clone + Into<Vec<u8>>>( &self, keys: &[K], val: &V, ) -> Result<u64, SuberError>

Appends a value with an automatically assigned ordinal number

§Returns
  • Ordinal number of newly appended value
§Parameters
  • keys - Top keys as prefix to be combined with serialized on suffix and sep to form key
  • val - Serialization
Source

pub fn get_on<K: AsRef<[u8]>, R: TryFrom<Vec<u8>>>( &self, keys: &[K], on: u32, ) -> Result<Option<R>, SuberError>
where <R as TryFrom<Vec<u8>>>::Error: Debug,

Gets a value at a key with an ordinal number

§Returns
  • Serialization at onkey if any
  • None if no entry at onkey
§Parameters
  • keys - Keys as prefix to be combined with serialized on suffix and sep to form onkey
  • on - Ordinal number used to form key
Source

pub fn rem_on<K: AsRef<[u8]>>( &self, keys: &[K], on: u32, ) -> Result<bool, SuberError>

Removes a value at a key with an ordinal number

§Returns
  • true if onkey made from key+sep+serialized on is found in database so value is removed
  • false otherwise
§Parameters
  • keys - Keys as prefix to be combined with serialized on suffix and sep to form onkey
  • on - Ordinal number used to form key
Source

pub fn cnt_on<K: AsRef<[u8]>>( &self, keys: &[K], on: u32, ) -> Result<usize, SuberError>

Counts the number of values with ordinal number suffix

§Returns
  • Count of all ordinal suffix keyed vals with same key prefix but different on in onkey
§Parameters
  • keys - Top keys as prefix to be combined with serialized on suffix and sep to form top key
  • on - Ordinal number used to form key
Source

pub fn get_on_iter<K: AsRef<[u8]>, R: TryFrom<Vec<u8>> + 'static>( &self, keys: &[K], on: u32, ) -> Result<Vec<R>, SuberError>
where <R as TryFrom<Vec<u8>>>::Error: Debug,

Gets an iterator over values with ordinal number suffix >= on

§Returns
  • Iterator over values with same key but increments of on >= on
§Parameters
  • keys - Keys as prefix to be combined with serialized on suffix and sep to form actual key
  • on - Ordinal number used to form key at which to initiate retrieval
Source

pub fn get_on_item_iter<K: AsRef<[u8]>, R: TryFrom<Vec<u8>> + 'static>( &self, keys: &[K], on: u32, ) -> Result<Vec<(Vec<Vec<u8>>, u64, R)>, SuberError>
where <R as TryFrom<Vec<u8>>>::Error: Debug,

Gets an iterator over (key, on, val) triples with ordinal number suffix >= on

§Returns
  • Iterator over (key, on, val) triples with same key but increments of on >= on
§Parameters
  • keys - Keys as prefix to be combined with serialized on suffix and sep to form actual key
  • on - Ordinal number used to form key at which to initiate retrieval

Auto Trait Implementations§

§

impl<C> Freeze for OnSuberBase<C>

§

impl<C> RefUnwindSafe for OnSuberBase<C>
where C: RefUnwindSafe,

§

impl<C> Send for OnSuberBase<C>
where C: Send,

§

impl<C> Sync for OnSuberBase<C>
where C: Sync,

§

impl<C> Unpin for OnSuberBase<C>
where C: Unpin,

§

impl<C> UnsafeUnpin for OnSuberBase<C>

§

impl<C> UnwindSafe for OnSuberBase<C>
where C: 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