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

A helper struct to prevent mistyping of a StashCollection’s name and k,v types.

Implementations§

source§

impl<K, V> TypedCollection<K, V>
where K: Data, V: Data,

source

pub async fn migrate_to<K2, V2>( &self, tx: &Transaction<'_>, f: impl for<'a> FnOnce(&'a BTreeMap<K, V>) -> Vec<MigrationAction<K, K2, V2>> ) -> Result<(), StashError>
where K2: Data, V2: Data,

Provided a closure, will migrate a TypedCollection of types K and V to types K2 and V2.

source

pub async fn initialize( &self, tx: &Transaction<'_>, values: impl IntoIterator<Item = (K, V)> ) -> Result<(), StashError>

Initializes a TypedCollection with the values provided in values.

Panics
source§

impl<K, V> TypedCollection<K, V>

source

pub const fn new(name: &'static str) -> Self

Creates a new TypedCollection with name.

source

pub const fn name(&self) -> &'static str

Returns the name of this TypedCollection.

source§

impl<K, V> TypedCollection<K, V>
where K: Data, V: Data,

source

pub async fn from_tx( &self, tx: &Transaction<'_> ) -> Result<StashCollection<K, V>, StashError>

Returns a StashCollection corresponding to this TypedCollection.

source

pub async fn iter( &self, stash: &mut Stash ) -> Result<Vec<((K, V), Timestamp, Diff)>, StashError>

Returns all ((key, value), timestamp, diff) tuples in this TypedCollection.

source

pub async fn peek_one( &self, stash: &mut Stash ) -> Result<BTreeMap<K, V>, StashError>

Returns all key, value pairs in this TypedCollection.

source

pub async fn peek_key_one( &self, stash: &mut Stash, key: K ) -> Result<Option<V>, StashError>
where K: 'static,

Returns the value of key in this TypedCollection.

source

pub async fn insert_key_without_overwrite( &self, stash: &mut Stash, key: K, value: V ) -> Result<V, StashError>
where K: 'static, V: Clone + 'static,

Sets the given k,v pair, if not already set.

Returns the new value stored in stash after this operations.

source

pub async fn insert_without_overwrite<I>( &self, stash: &mut Stash, entries: I ) -> Result<BTreeMap<K, V>, StashError>
where I: IntoIterator<Item = (K, V)>, K: Clone + 'static, V: Clone + 'static,

Sets the given key value pairs, if not already set. If a new key appears multiple times in entries, its value will be from the first occurrence in entries.

Returns the new state of the collection after this operation.

source

pub async fn upsert_key<F, R>( &self, stash: &mut Stash, key: K, f: F ) -> Result<Result<(Option<V>, V), R>, StashError>
where F: FnOnce(Option<&V>) -> Result<V, R> + Clone + Send + Sync + 'static, K: 'static,

Sets a value for a key to the result of f. f is passed the previous value, if any.

Returns the previous value if one existed and the value returned from f.

source

pub async fn upsert<I>( &self, stash: &mut Stash, entries: I ) -> Result<(), StashError>
where I: IntoIterator<Item = (K, V)>, K: 'static, V: 'static,

Sets the given key value pairs, removing existing entries match any key.

source

pub async fn delete_keys( &self, stash: &mut Stash, keys: BTreeSet<K> ) -> Result<(), StashError>
where K: Clone + 'static, V: Clone,

Transactionally deletes any kv pair from self whose key is in keys.

Note that:

  • Unlike delete, this operation operates in time O(keys), and not O(set), however does so by parallelizing a number of point queries so is likely not performant for more than 10-or-so keys.
  • This operation runs in a single transaction and cannot be combined with other transactions.

Auto Trait Implementations§

§

impl<K, V> RefUnwindSafe for TypedCollection<K, V>

§

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

§

impl<K, V> Sync for TypedCollection<K, V>
where K: Sync, V: Sync,

§

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

§

impl<K, V> UnwindSafe for TypedCollection<K, V>
where K: UnwindSafe, V: 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, 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> PushInto<Vec<T>> for T

source§

fn push_into(self, target: &mut Vec<T>)

Push self into the target container.
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