Skip to main content

EventsService

Struct EventsService 

Source
pub struct EventsService { /* private fields */ }

Implementations§

Source§

impl EventsService

Source

pub fn new() -> EventsService

Source

pub fn listener_count(&self, event: &str) -> usize

Count of non-cancelled listeners registered on event, across BOTH registries (flat + waterfall). Read-only — no pruning writes — so the zero-cost gate for every interception point is one pair of map lookups.

Source

pub fn dispatch_snapshot(&self) -> (u64, Vec<(String, u64)>)

Subscribe to the fire-and-forget emit broadcast bus. Snapshot of dispatch counters: (total, per-event sorted ascending).

Source

pub fn subscribe(&self) -> Receiver<(String, Value)>

Subscribe to the fire-and-forget emit broadcast bus.

Source

pub fn once<F, Fut>(&self, event: String, handler: F) -> Box<dyn Disposable>
where F: Fn(Value) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Register a one-shot flat listener.

The returned handle is the same early-cancel subscription Self::on yields; disposing it before the event ever fires unregisters the listener. Exactly-once is claimed AT INVOCATION through an atomic swap, so concurrent dispatches of the same event run the handler on exactly one task and every later dispatch observes an already-spent (skipped) slot. Delegates to Self::once_with with default options; a bail-chain-skipped listener stays registered until it actually runs (see Self::once_with).

Source

pub fn once_with<F, Fut>( &self, event: String, options: EventOptions, handler: F, ) -> Box<dyn Disposable>
where F: Fn(Value) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Register a one-shot flat listener with explicit EventOptions.

The claim/dispose flag discipline is identical to Self::once; options.prepend controls the insertion position in the dispatch-order list, options.global marks the listener as exempt from context filters in Self::emit_filtered. The historical Self::once delegates here with default options.

Source

pub fn on<F, Fut>(&self, event: String, handler: F) -> Box<dyn Disposable>
where F: Fn(Value) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Source

pub fn on_with<F, Fut>( &self, event: String, options: EventOptions, handler: F, ) -> Box<dyn Disposable>
where F: Fn(Value) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Register a flat listener with explicit EventOptions: prepend inserts at the front of the dispatch-order list, global marks the listener as realm-agnostic for Self::emit_filtered. The historical Self::on delegates here with default options.

Source

pub fn on_waterfall<F, Fut>( &self, event: String, handler: F, ) -> Box<dyn Disposable>
where F: Fn(Value, Box<dyn FnOnce(Value) -> Pin<Box<dyn Future<Output = Result<Value, CordisError>> + Send>> + Send>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Register a Cordis waterfall around-middleware handler.

handler receives the current payload and a next continuation. Calling next(payload) runs the downstream chain and yields its (possibly transformed) result; NOT calling next short-circuits the chain so later handlers do not run. Handlers registered here are only invoked by dispatch with Dispatch::Waterfall; the plain on registry is used for emit/parallel/serial/bail.

Source

pub fn emit_filtered( &self, event: String, args: Value, filter: Box<dyn Fn(&EventOptions) -> bool + Sync + Send>, ) -> Result<Value, CordisError>

Filtered fire-and-forget emit: like Dispatch::Emit via Self::dispatch, but non-global listeners are offered to filter first — a false verdict excludes the listener from this dispatch without unregistering it. Global listeners bypass the filter.

The broadcast bus fan-out is NOT filtered (it has no listener metadata to filter on); only registered handlers participate in filtering. Returns null like every emit path.

Source

pub async fn bail_from( &self, event: String, payload: Value, filter: Option<Box<dyn Fn(&EventOptions) -> bool + Sync + Send>>, ) -> Result<Value, CordisError>

Target-carrying Bail dispatch: like Dispatch::Bail through Self::dispatch, but non-global flat listeners whose registration options fail filter do not participate in THIS dispatch (they stay registered). The filter closure captures the operating context at the call site, so per-dispatch decisions evaluate against it. Kernel meta-events ride here for their veto chains.

Source

pub async fn waterfall_from( &self, event: String, payload: Value, filter: Option<Box<dyn Fn(&EventOptions) -> bool + Sync + Send>>, ) -> Result<Value, CordisError>

Target-carrying Waterfall dispatch with identity terminal: the same chain as Dispatch::Waterfall through Self::dispatch, plus per-dispatch filtering of the waterfall registry.

Source

pub async fn dispatch( &self, event: String, payload: Value, mode: Dispatch, ) -> Result<Value, CordisError>

Source

pub async fn waterfall_around<F, Fut>( &self, event: String, payload: Value, core: F, ) -> Result<Value, CordisError>
where F: FnOnce(Value) -> Fut + Send + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Around-middleware waterfall whose terminal next is core rather than identity.

Snapshot active waterfall handlers for event. With none registered, core runs immediately. Otherwise the same chain as [dispatch] with Dispatch::Waterfall, except index >= handlers.len() invokes core instead of returning the payload unchanged. [dispatch] Waterfall stays identity-at-end.

Source

pub async fn waterfall_async_from<F, Fut>( &self, event: String, payload: Value, filter: Option<Box<dyn Fn(&EventOptions) -> bool + Sync + Send>>, core: F, ) -> Result<Value, CordisError>
where F: FnOnce(Value) -> Fut + Send + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Target-carrying around-middleware waterfall whose terminal next is core: Self::waterfall_around plus per-dispatch listener filtering. The operating context rides along through whatever the caller closes over in filter.

Source

pub async fn intercept_get( &self, service: &str, ctx_hint: Option<String>, ) -> Result<Option<Value>, CordisError>

Strict service read interception at the internal/get veto point.

No listeners ⇒ Ok(None) at map-lookup cost (zero-cost gate). A Bail chain yielding null passes the read through untouched; a non-null result REPLACES what the consumer sees; a chain error vetoes the read.

Source

pub async fn intercept_set( &self, service: &str, ctx_hint: Option<String>, ) -> Result<(), CordisError>

Service-write interception at the internal/set veto point. A chain error vetoes the write (the previous value stays); null / pass-through allows the write unchanged.

Source

pub async fn intercept_config(&self, raw: Value) -> Result<Value, CordisError>

Config-resolution interception at the internal/config veto point. The chain’s non-null terminal IS the effective configuration; null passes raw through untouched; a chain error fails the activation / update that was resolving config.

Source

pub async fn intercept_update(&self, service: &str) -> Result<bool, CordisError>

Restart-schedule interception at the internal/update veto point. Ok(true) proceeds with the restart; Ok(false) (a bail or an explicit JSON false) vetoes — the caller stores its pending config and skips the restart. A chain error propagates to the caller.

Source

pub async fn intercept_listener(&self, event: &str) -> Result<bool, CordisError>

Listener-registration interception at the internal/listener veto point. Ok(true) lets the registration proceed; a bail (non-null non-true result) or a chain error cancels it — the caller returns an inert handle without touching either registry.

Source

pub async fn dispatch_typed<E>( &self, payload: &<E as TypedEvent>::Payload, ) -> Result<Value, CordisError>
where E: TypedEvent,

Typed dispatch: serialize the payload struct for E’s event and dispatch with the declared mode. Equivalent to dispatch with a pre-validated name/mode pair; serialization failure is a CordisError::Configuration.

Source

pub fn on_typed<E, F, Fut>(&self, handler: F) -> Box<dyn Disposable>
where E: TypedEvent, F: Fn(<E as TypedEvent>::Payload) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Typed flat listener: the handler receives the deserialized payload struct instead of raw JSON.

A payload that fails to deserialize is skipped with a warning and the incoming value passes through unchanged (for Serial/Bail chains this preserves pass-through semantics). Registration still goes through the same debug contract enforcement as on.

Source

pub fn on_typed_waterfall<E, F, Fut>(&self, handler: F) -> Box<dyn Disposable>
where E: TypedEvent, F: Fn(<E as TypedEvent>::Payload, Box<dyn FnOnce(Value) -> Pin<Box<dyn Future<Output = Result<Value, CordisError>> + Send>> + Send>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<Value, CordisError>> + Send + 'static,

Typed around-middleware waterfall: the handler receives the deserialized payload struct plus the raw-JSON WaterfallNext continuation. The rest of the chain keeps working on serialized values; delegating handlers re-parse inside next, mirroring upstream TS where next carries serialized args.

Trait Implementations§

Source§

impl Default for EventsService

Source§

fn default() -> EventsService

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

impl Service for EventsService

Source§

fn name(&self) -> &'static str

Source§

fn init( &self, _ctx: &Arc<Context>, ) -> Pin<Box<dyn Future<Output = Result<Option<Box<dyn Disposable>>, CordisError>> + Send + '_>>

Source§

fn check(&self) -> bool

Availability predicate for this service instance. 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<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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> MaybeSendSync for T

Source§

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

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

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

Source§

type Error = !

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