Struct KeyedBatchHook 

pub struct KeyedBatchHook<K, V, O: Ordering = TotalOrder, R: Retries = ExactlyOnce> { /* private fields */ }

A hook handle controlling a batch operator over a keyed stream with keys K, values V, per-key value ordering O, and retry guarantee R (mirroring the type of the keyed stream being batched).

A decision for a keyed batch hook says which buffered (key, value) entries form the next batch released into the tick. See hydro_lang::sim::hooks for the decisions offered.

Implementations

impl<K, V, O: Ordering, R: Retries> KeyedBatchHook<K, V, O, R>

pub fn pause(&self)

Available on crate feature sim only.

Declares that buffering at this operator is intended: while paused, the hook is exempt from the missing-decision error, never causes its tick to run, and — if its tick runs anyway because other hooks feed it — contributes its “nothing new” behavior each time. Scripting any decision implicitly resumes the hook.

A pause takes its place in the script like everything else: requested while a decision is still pending, the hold begins once that decision has been consumed.

pub fn resume(&self)

Available on crate feature sim only.

Ends a Self::pause (and clears Self::auto_pause mode).

pub fn auto_pause(&self)

Available on crate feature sim only.

Sets a standing mode where this hook only ever acts when scripted: it holds immediately, and every scripted decision leaves a fresh hold in place behind it.

This deliberately opts out of the forgotten-hook protection: if the test forgets a step, the operator silently holds its data instead of failing. The one auto_pause() line at the top of a test is the reviewer-visible marker that this hook’s timing is entirely script-driven, missed steps and all.

pub async fn pause_while<Fut: Future>(&self, body: Fut) -> Fut::Output

Available on crate feature sim only.

Pauses the hook exactly for the duration of body (resuming even on panic), so a bracketed buffering phase cannot leak a paused hook.

pub fn pause_until( &self, predicate: impl Fn(&BatchStatus) -> bool + Unpin, ) -> PauseUntilFuture<BatchStatus, impl Fn(&BatchStatus) -> bool + Unpin>

Available on crate feature sim only.

Pauses the hook and returns a future that resolves once the hook’s pending-input status satisfies predicate — a synchronization point for scripts where the right decision is not knowable upfront. The status is read on demand at every scheduling point. After the future resolves, the hook is unpaused; the ordinary missing-decision error applies from there on.

pub fn pause_until_count( &self, n: usize, ) -> PauseUntilFuture<BatchStatus, impl Fn(&BatchStatus) -> bool + Unpin>

Available on crate feature sim only.

Pauses the hook and returns a future that resolves once at least n entries are buffered (in total, across all keys); see Self::pause_until.

impl<K, V, R: Retries> KeyedBatchHook<K, V, TotalOrder, R>

where K: Serialize + DeserializeOwned + PartialEq, V: Serialize + DeserializeOwned + PartialEq,

pub fn release( &self, counts: impl IntoIterator<Item = (K, usize)>, ) -> DecisionFuture

where K: Hash + Eq,

Available on crate feature sim only.

Scripts the next batch to be exactly the next count buffered values of each named key. The tick fires at the first moment the decision can be honored in full.

Panics

Panics immediately if counts names the same key more than once.

pub fn release_values( &self, entries: impl IntoIterator<Item = (K, V)>, ) -> DecisionFuture

Available on crate feature sim only.

Scripts the next batch to be exactly these (key, value) entries. Each key’s values must match that key’s buffered prefix in order (the interleaving of different keys in the scripted sequence is irrelevant): a mismatching available value panics immediately, while a matching but incomplete prefix waits for the remaining values to arrive.

pub fn release_all(&self) -> DecisionFuture

Available on crate feature sim only.

Scripts the next batch to be everything that has arrived by the time the tick fires. Under fuzzing, the released contents co-vary with the schedule being explored; use Self::release_values to name them exactly.

pub fn release_empty(&self) -> DecisionFuture

Available on crate feature sim only.

Scripts the next batch to be empty, holding everything buffered. Shorthand for Self::release_values with no entries.

impl<K, V, R: Retries> KeyedBatchHook<K, V, NoOrder, R>

where K: Serialize + DeserializeOwned + PartialEq, V: Serialize + DeserializeOwned + PartialEq,

pub fn release_values( &self, entries: impl IntoIterator<Item = (K, V)>, ) -> DecisionFuture

Available on crate feature sim only.

Scripts the next batch to contain exactly these (key, value) entries. Values are matched per key as multisets (independently of arrival order); duplicates request the corresponding number of equal buffered items. The tick fires once every requested entry exists.

pub fn release_all(&self) -> DecisionFuture

Available on crate feature sim only.

Scripts the next batch to be everything that has arrived by the time the tick fires. Under fuzzing, the released contents co-vary with the schedule being explored; use Self::release_values to name them exactly.

pub fn release_empty(&self) -> DecisionFuture

Available on crate feature sim only.

Scripts the next batch to be empty, holding everything buffered. Shorthand for Self::release_values with no entries.

Trait Implementations

impl<K, V, O: Ordering, R: Retries> Clone for KeyedBatchHook<K, V, O, R>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K, V, O: Ordering, R: Retries> Copy for KeyedBatchHook<K, V, O, R>

impl<K, V, O: Ordering, R: Retries> Debug for KeyedBatchHook<K, V, O, R>

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

Formats the value using the given formatter.

impl<K, V, O: Ordering, R: Retries> SimHook for KeyedBatchHook<K, V, O, R>

where K: Hash + Eq + Clone + Serialize + DeserializeOwned, V: Serialize + DeserializeOwned + PartialEq,

fn create(next_id: &mut dyn FnMut() -> usize) -> Self

Creates every handle in this value, allocating fresh IDs via next_id.