Struct mz_persist_client::internal::maintenance::RoutineMaintenance

pub struct RoutineMaintenance {
    pub(crate) garbage_collection: Option<GcReq>,
    pub(crate) write_rollup: Option<SeqNo>,
}

Every handle to this shard may be occasionally asked to perform routine maintenance after a successful compare_and_set operation.

For one-shot operations (like registering a reader) handles are allowed to skip routine maintenance if necessary, as the same maintenance operations will be recomputed by the next successful compare_and_set of any handle.

Operations that run regularly once a handle is registered, such as heartbeats, are expected to always perform maintenance.

Fields

garbage_collection: Option<GcReq>

write_rollup: Option<SeqNo>

Implementations

impl RoutineMaintenance

pub(crate) fn is_empty(&self) -> bool

pub(crate) fn start_performing<K, V, T, D>( self, machine: &Machine<K, V, T, D>, gc: &GarbageCollector<K, V, T, D> )where K: Debug + Codec, V: Debug + Codec, T: Timestamp + Lattice + Codec64, D: Semigroup + Codec64 + Send + Sync,

Initiates any routine maintenance necessary in background tasks

pub(crate) async fn perform<K, V, T, D>( self, machine: &Machine<K, V, T, D>, gc: &GarbageCollector<K, V, T, D> )where K: Debug + Codec, V: Debug + Codec, T: Timestamp + Lattice + Codec64, D: Semigroup + Codec64 + Send + Sync,

Performs any routine maintenance necessary. Returns when all background tasks have completed and the maintenance is done.

Generally, clients should prefer start_performing since it’s typically not critical that maintenance is performed by any particular deadline.

fn perform_in_background<K, V, T, D>( self, machine: &Machine<K, V, T, D>, gc: &GarbageCollector<K, V, T, D> ) -> Vec<BoxFuture<'static, RoutineMaintenance>>where K: Debug + Codec, V: Debug + Codec, T: Timestamp + Lattice + Codec64, D: Semigroup + Codec64 + Send + Sync,

Initiates maintenance work in the background, either through spawned tasks or by sending messages to existing tasks. The returned futures may be awaited to know when the work is completed, but do not need to be polled to drive the work to completion.

pub fn merge(&mut self, other: RoutineMaintenance)

Merges another maintenance request into this one.

other is expected to come “later”, and so its maintenance might override self’s maintenance.

Trait Implementations

impl Debug for RoutineMaintenance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RoutineMaintenance

fn default() -> RoutineMaintenance

Returns the “default value” for a type.

impl PartialEq for RoutineMaintenance

fn eq(&self, other: &RoutineMaintenance) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for RoutineMaintenance