Skip to main content

BlockHint

Enum BlockHint 

Source
pub enum BlockHint {
    None,
    Block {
        kind: BlockKind,
        keys: Vec<Vec<u8>>,
        timeout_ms: u64,
    },
}
Expand description

How a command wants to block, if at all. Returned by Commands::resolve inside crate::ResolvedCmd so the verb-table lookup happens once per command. None is the zero-cost default for every non-blocking verb (≥ 99.9 % of dispatches in steady state).

keys is every key the conn watches (≥ 1). The dispatcher picks the park strategy from them:

  • single key on the conn’s own shard → the in-shard fast path (BlockedClients): register + wake without any cross-core hop.
  • single remote key, or any multi-key form → the cross-shard arbiter (block_xshard): the conn parks on its origin shard and watch registrations fan out to each key’s owning shard.

For BLPOP / BRPOP the keys are list keys; for XREAD BLOCK / XREADGROUP BLOCK they are the STREAMS keys (in request order).

Variants§

§

None

§

Block

Fields

§keys: Vec<Vec<u8>>
§timeout_ms: u64

0 = block forever (Redis convention). Anything else is the wall-clock millis the dispatcher will add to unix_now_ms() to derive the waiter’s deadline_ms.

Trait Implementations§

Source§

impl Clone for BlockHint

Source§

fn clone(&self) -> BlockHint

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BlockHint

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BlockHint

Source§

fn default() -> BlockHint

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.