Struct OrderingHook 

pub struct OrderingHook<T, B: Boundedness = Unbounded> { /* private fields */ }

A hook handle controlling an assume_ordering operator over T elements.

A top-level decision selects the next buffered element to release. An assume_ordering inside a tick instead takes one exhaustive ordering of that tick’s complete input. See hydro_lang::sim::hooks for the decisions offered.

Implementations

impl<T> OrderingHook<T, Unbounded>

where T: Serialize + DeserializeOwned,

pub fn next(&self, value: T) -> DecisionFuture

Available on crate feature sim only.

Scripts a top-level assume_ordering action to release the buffered element equal to value. Exactly one element is released, preserving opportunities for ticks and feedback to interleave with the remaining buffered input.

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(&OrderingStatus) -> bool + Unpin, ) -> PauseUntilFuture<OrderingStatus, impl Fn(&OrderingStatus) -> 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<OrderingStatus, impl Fn(&OrderingStatus) -> bool + Unpin>

Available on crate feature sim only.

Pauses a top-level ordering hook until at least n elements are buffered; see Self::pause_until.

impl<T> OrderingHook<T, Bounded>

where T: Serialize + DeserializeOwned,

pub fn order(&self, values: impl IntoIterator<Item = T>) -> DecisionFuture

Available on crate feature sim only.

Scripts an in-tick assume_ordering observation to consume its complete input in exactly this order. The supplied values must be a permutation of all values received by the operator during that tick.

Trait Implementations

impl<T, B: Boundedness> Clone for OrderingHook<T, B>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, B: Boundedness> Copy for OrderingHook<T, B>

impl<T, B: Boundedness> Debug for OrderingHook<T, B>

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

Formats the value using the given formatter.

impl<T, B: Boundedness> SimHook for OrderingHook<T, B>

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

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