pub struct RocksDBInstance<K, V> { /* private fields */ }
Expand description

An async wrapper around RocksDB.

Implementations§

source§

impl<K, V> RocksDBInstance<K, V>
where K: AsRef<[u8]> + Send + Sync + 'static, V: Serialize + DeserializeOwned + Send + Sync + 'static,

source

pub async fn new<M, O, IM>( instance_path: &Path, legacy_instance_path: &Path, options: InstanceOptions, tuning_config: RocksDBConfig, shared_metrics: M, instance_metrics: IM, enc_opts: O ) -> Result<Self, Error>
where O: Options + Copy + Send + Sync + 'static, M: Deref<Target = RocksDBSharedMetrics> + Send + 'static, IM: Deref<Target = RocksDBInstanceMetrics> + Send + 'static,

Start a new RocksDB instance at the path, using the Options and RocksDBTuningParameters to configure the instance.

metrics is a set of metric types that this type will keep up to date. enc_opts is the bincode options used to serialize and deserialize the keys and values.

source

pub async fn multi_get<'r, G, R, Ret, Placement>( &mut self, gets: G, results_out: R, placement: Placement ) -> Result<MultiGetResult, Error>
where G: IntoIterator<Item = K>, R: IntoIterator<Item = &'r mut Ret>, Ret: 'r, Placement: Fn(Option<GetResult<V>>) -> Ret,

For each unique key in gets, place the stored value (if any) in results_out.

Panics if gets and results_out are not the same length.

source

pub async fn multi_put<P>(&mut self, puts: P) -> Result<MultiPutResult, Error>
where P: IntoIterator<Item = (K, Option<V>)>,

For each key in puts, store the given value, or delete it if the value is None. If the same key appears multiple times, the last value for the key wins.

source

pub async fn close(self) -> Result<(), Error>

Gracefully shut down RocksDB. Can error if the instance is already shut down or errored.

Auto Trait Implementations§

§

impl<K, V> !RefUnwindSafe for RocksDBInstance<K, V>

§

impl<K, V> Send for RocksDBInstance<K, V>
where K: Send, V: Send,

§

impl<K, V> Sync for RocksDBInstance<K, V>
where K: Send + Sync, V: Send + Sync,

§

impl<K, V> Unpin for RocksDBInstance<K, V>
where K: Unpin, V: Unpin,

§

impl<K, V> !UnwindSafe for RocksDBInstance<K, V>

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, U> CastInto<U> for T
where U: CastFrom<T>,

source§

fn cast_into(self) -> U

Performs the cast.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FutureExt for T

source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<P, R> ProtoType<R> for P
where R: RustType<P>,

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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