Skip to main content

SubscriptionEventNotifier

Struct SubscriptionEventNotifier 

Source
pub struct SubscriptionEventNotifier<'a, 'b> { /* private fields */ }
Expand description

Handle for notifying the subscription cache of a batch of events, without allocating NodeIds unnecessarily. Notifications are actually submitted once the notifier is dropped.

Implementations§

Source§

impl<'a, 'b> SubscriptionEventNotifier<'a, 'b>

Source

pub fn notify_for<'c>( &'c mut self, node_id: impl IntoNodeIdRef<'a>, ) -> Option<SubscriptionEventNotifierBatch<'c, 'b>>

Maybe get a notifier for the given node ID and attribute ID.

This allows you to only sample when a user is listening.

§Example
if let Some(mut notif) = notifier.notify_for((1, 123)) {
    notif.event(&my_event);
    notif.event(&my_other_event);
}
Source

pub fn notify(&mut self, node_id: impl IntoNodeIdRef<'a>, event: &'b dyn Event)

Notify the subscription cache of a new event for the given node ID and attribute ID.

§Arguments
  • node_id - The node ID or reference to node ID for the node emitting the event.
  • event - The event to notify the server of.

Trait Implementations§

Source§

impl<'a, 'b> Drop for SubscriptionEventNotifier<'a, 'b>

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a, 'b> Freeze for SubscriptionEventNotifier<'a, 'b>

§

impl<'a, 'b> !RefUnwindSafe for SubscriptionEventNotifier<'a, 'b>

§

impl<'a, 'b> !Send for SubscriptionEventNotifier<'a, 'b>

§

impl<'a, 'b> !Sync for SubscriptionEventNotifier<'a, 'b>

§

impl<'a, 'b> Unpin for SubscriptionEventNotifier<'a, 'b>

§

impl<'a, 'b> UnsafeUnpin for SubscriptionEventNotifier<'a, 'b>

§

impl<'a, 'b> !UnwindSafe for SubscriptionEventNotifier<'a, 'b>

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

Source§

type Output = T

Should always be Self
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
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