pub struct DurableCache<C: DurableCacheCodec> {
pub(crate) since_handle: SinceHandle<C::KeyCodec, C::ValCodec, u64, i64, i64>,
pub(crate) write: WriteHandle<C::KeyCodec, C::ValCodec, u64, i64>,
pub(crate) subscribe: Subscribe<C::KeyCodec, C::ValCodec, u64, i64>,
pub(crate) local: BTreeMap<C::Key, LocalVal<C>>,
pub(crate) local_progress: u64,
}
Fields§
§since_handle: SinceHandle<C::KeyCodec, C::ValCodec, u64, i64, i64>
§write: WriteHandle<C::KeyCodec, C::ValCodec, u64, i64>
§subscribe: Subscribe<C::KeyCodec, C::ValCodec, u64, i64>
§local: BTreeMap<C::Key, LocalVal<C>>
§local_progress: u64
Implementations§
Source§impl<C: DurableCacheCodec> DurableCache<C>
impl<C: DurableCacheCodec> DurableCache<C>
Sourcepub async fn new(
persist: &PersistClient,
shard_id: ShardId,
purpose: &str,
) -> Self
pub async fn new( persist: &PersistClient, shard_id: ShardId, purpose: &str, ) -> Self
Opens a DurableCache
using shard shard_id
.
pub(crate) async fn sync_to(&mut self, progress: Option<u64>) -> u64
Sourcepub fn get_local(&self, key: &C::Key) -> Option<&C::Val>
pub fn get_local(&self, key: &C::Key) -> Option<&C::Val>
Get and return the value associated with key
if it exists, without syncing with the
durable store.
Sourcepub async fn get(
&mut self,
key: &C::Key,
val_fn: impl FnOnce() -> C::Val,
) -> &C::Val
pub async fn get( &mut self, key: &C::Key, val_fn: impl FnOnce() -> C::Val, ) -> &C::Val
Get and return the value associated with key
, syncing with the durable store if
necessary. If key
does not exist, then a value is computed via val_fn
and durably
stored in the cache.
Sourcepub fn entries_local(&self) -> impl Iterator<Item = (&C::Key, &C::Val)>
pub fn entries_local(&self) -> impl Iterator<Item = (&C::Key, &C::Val)>
Return all entries stored in the cache, without syncing with the durable store.
Sourcepub async fn set(&mut self, key: &C::Key, value: Option<&C::Val>)
pub async fn set(&mut self, key: &C::Key, value: Option<&C::Val>)
Durably set key
to value
. A value
of None
deletes the entry from the cache.
Failures will update the cache and retry until the cache is written successfully.
Sourcepub async fn set_many(&mut self, entries: &[(&C::Key, Option<&C::Val>)])
pub async fn set_many(&mut self, entries: &[(&C::Key, Option<&C::Val>)])
Durably set multiple key-value pairs in entries
. Values of None
deletes the
corresponding entries from the cache.
Failures will update the cache and retry until the cache is written successfully.
Sourcepub async fn try_set(
&mut self,
key: &C::Key,
value: Option<&C::Val>,
) -> Result<(), Error>
pub async fn try_set( &mut self, key: &C::Key, value: Option<&C::Val>, ) -> Result<(), Error>
Tries to durably set key
to value
. A value
of None
deletes the entry from the cache.
On both successes and failures, the cache will update its contents with the most recent updates from the durable store.
Sourcepub async fn try_set_many(
&mut self,
entries: &[(&C::Key, Option<&C::Val>)],
) -> Result<(), Error>
pub async fn try_set_many( &mut self, entries: &[(&C::Key, Option<&C::Val>)], ) -> Result<(), Error>
Tries to durably set multiple key-value pairs in entries
. Values of None
deletes the
corresponding entries from the cache.
On both successes and failures, the cache will update its contents with the most recent updates from the durable store.
Sourcepub(crate) async fn compare_and_append<I>(
&mut self,
updates: I,
write_ts: u64,
) -> Result<u64, UpperMismatch<u64>>
pub(crate) async fn compare_and_append<I>( &mut self, updates: I, write_ts: u64, ) -> Result<u64, UpperMismatch<u64>>
Applies updates
to the cache at write_ts
. See WriteHandle::compare_and_append
for
more details.
This method will also downgrade the critical since of the underlying persist shard on success.
Sourcepub async fn dangerous_compact_shard(
&self,
fuel: impl Fn() -> usize,
wait: impl Fn() -> Duration,
)
pub async fn dangerous_compact_shard( &self, fuel: impl Fn() -> usize, wait: impl Fn() -> Duration, )
Forcibly compacts the shard backing this cache. See
mz_persist_client::cli::admin::dangerous_force_compaction_and_break_pushdown
.
Trait Implementations§
Auto Trait Implementations§
impl<C> Freeze for DurableCache<C>
impl<C> !RefUnwindSafe for DurableCache<C>
impl<C> Send for DurableCache<C>where
<C as DurableCacheCodec>::Key: Send,
<C as DurableCacheCodec>::KeyCodec: Send,
<C as DurableCacheCodec>::Val: Send,
<C as DurableCacheCodec>::ValCodec: Send,
impl<C> Sync for DurableCache<C>where
<C as DurableCacheCodec>::Key: Sync,
<C as DurableCacheCodec>::KeyCodec: Sync,
<C as DurableCacheCodec>::Val: Sync,
<C as DurableCacheCodec>::ValCodec: Sync,
impl<C> Unpin for DurableCache<C>
impl<C> !UnwindSafe for DurableCache<C>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
Source§fn into_rust(self) -> Result<R, TryFromProtoError>
fn into_rust(self) -> Result<R, TryFromProtoError>
RustType::from_proto
.Source§fn from_rust(rust: &R) -> P
fn from_rust(rust: &R) -> P
RustType::into_proto
.Source§impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
Source§fn plus_equals(&mut self, rhs: &&'a S)
fn plus_equals(&mut self, rhs: &&'a S)
std::ops::AddAssign
, for types that do not implement AddAssign
.