Skip to main content

EventMask

Struct EventMask 

Source
pub struct EventMask(/* private fields */);
Expand description

One bit per Hooks event kind — the union gate every dispatch call site (hook_gate!) checks before doing ANY per-event work: payload construction, the ≤2KB cap copy, deadline registration, cancel-race scaffolding. A session whose Hooks impl doesn’t register a given event pays exactly one branch on a cached u8 for it instead (§S1 HookRouter diet).

This is the union half of the design doc’s { union: EventMask, per_event: [SmallVec<[HookId;2]>; 6] } table (design-docs §S1). hotl has exactly one Hooks object per session — there is no multi-hook registry to index a per-event dispatch table against — so only the union mask and its gates land here; the per-event table is deliberately left out. A future multi-hook registry would extend EventMask to that per-event table; until then, a registered event still runs every matching hook internally (lane 1 merges in registration order, lane 2 runs matching shell hooks concurrently) — the mask only decides whether the wrapper runs at all.

Implementations§

Source§

impl EventMask

Source

pub const PRE_TOOL: EventMask

Source

pub const POST_TOOL: EventMask

Source

pub const USER_PROMPT: EventMask

Source

pub const NOTIFICATION: EventMask

Source

pub const STOP: EventMask

Source

pub const SESSION_END: EventMask

Source

pub const NONE: EventMask

No events registered — a zero-hook session’s cached mask.

Source

pub const ALL: EventMask

Every event registered — the trait default, so an impl that hasn’t opted into narrower dispatch (an external/unknown lane) stays correct.

Source

pub const fn contains(self, bit: EventMask) -> bool

Source

pub const fn union(self, other: EventMask) -> EventMask

Source

pub const fn difference(self, other: EventMask) -> EventMask

Clear other’s bits from self — used to narrow the mask when a three-strike eviction silences the last live hook for an event.

Source

pub const fn bits(self) -> u8

Source

pub const fn from_bits(bits: u8) -> EventMask

Bits outside the six defined here are masked off — forward-compat against a stray byte rather than a panic.

Trait Implementations§

Source§

impl Clone for EventMask

Source§

fn clone(&self) -> EventMask

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 Copy for EventMask

Source§

impl Debug for EventMask

Source§

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

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

impl Default for EventMask

Source§

fn default() -> EventMask

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

impl Eq for EventMask

Source§

impl PartialEq for EventMask

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EventMask

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more