Struct RefEvent 

pub struct RefEvent<'a, T>
where
    T: Send,
{ /* private fields */ }

An event referenced via & shared reference.

Only used in type names. Instances are created internally by OnceEvent.

Methods from Deref<Target = OnceEvent<T>>

pub fn bind_by_ref( &self, ) -> (OnceSender<RefEvent<'_, T>>, OnceReceiver<RefEvent<'_, T>>)

Returns both the sender and receiver for this event, connected by a shared reference to the event.

Panics

Panics if the event has already been bound to a sender-receiver pair.

Example

use events::OnceEvent;

let event = OnceEvent::<i32>::new();
let (sender, receiver) = event.bind_by_ref();

pub fn bind_by_ref_checked( &self, ) -> Option<(OnceSender<RefEvent<'_, T>>, OnceReceiver<RefEvent<'_, T>>)>

Returns both the sender and receiver for this event, connected by a shared reference to the event.

Returns None if the event has already been bound to a sender-receiver pair.

Example

use events::OnceEvent;

let event = OnceEvent::<i32>::new();
let endpoints = event.bind_by_ref_checked().unwrap();
let endpoints2 = event.bind_by_ref_checked(); // Returns None
assert!(endpoints2.is_none());

pub unsafe fn bind_by_ref_unchecked( &self, ) -> (OnceSender<RefEvent<'_, T>>, OnceReceiver<RefEvent<'_, T>>)

Returns both the sender and receiver for this event, connected by a shared reference to the event.

This method assumes the event is not already bound and skips the check for performance.

Safety

The caller must guarantee the event is not already bound.

Example

use events::OnceEvent;

let event = OnceEvent::<i32>::new();
// We know this is the first and only binding of this event
// SAFETY: We know this is the first and only binding of this event
let (sender, receiver) = unsafe { event.bind_by_ref_unchecked() };

pub fn bind_by_arc( self: &Arc<Self>, ) -> (OnceSender<ArcEvent<T>>, OnceReceiver<ArcEvent<T>>)

Returns both the sender and receiver for this event, connected by an Arc to the event.

This method requires the event to be wrapped in an Arc when called.

Panics

Panics if the event has already been bound to a sender-receiver pair.

Example

use std::sync::Arc;

use events::OnceEvent;

let event = Arc::new(OnceEvent::<i32>::new());
let (sender, receiver) = event.bind_by_arc();

pub fn bind_by_arc_checked( self: &Arc<Self>, ) -> Option<(OnceSender<ArcEvent<T>>, OnceReceiver<ArcEvent<T>>)>

Returns both the sender and receiver for this event, connected by an Arc to the event.

Returns None if the event has already been bound to a sender-receiver pair.

This method requires the event to be wrapped in an Arc when called.

Example

use std::sync::Arc;

use events::OnceEvent;

let event = Arc::new(OnceEvent::<i32>::new());
let endpoints = event.bind_by_arc_checked().unwrap();
let endpoints2 = event.bind_by_arc_checked(); // Returns None
assert!(endpoints2.is_none());

pub unsafe fn bind_by_arc_unchecked( self: &Arc<Self>, ) -> (OnceSender<ArcEvent<T>>, OnceReceiver<ArcEvent<T>>)

Returns both the sender and receiver for this event, connected by an Arc to the event.

This method assumes the event is not already bound and skips the check for performance.

This method requires the event to be wrapped in an Arc when called.

Safety

The caller must guarantee the event is not already bound.

Example

use std::sync::Arc;

use events::OnceEvent;

let event = Arc::new(OnceEvent::<i32>::new());
// We know this is the first and only binding of this event
// SAFETY: We know this is the first and only binding of this event
let (sender, receiver) = unsafe { event.bind_by_arc_unchecked() };

pub unsafe fn bind_by_ptr( self: Pin<&Self>, ) -> (OnceSender<PtrEvent<T>>, OnceReceiver<PtrEvent<T>>)

Returns both the sender and receiver for this event, connected by a raw pointer to the event.

This method requires the event to be pinned when called.

Safety

The caller must ensure that:

• The event remains alive and pinned for the entire lifetime of the sender and receiver.
• The sender and receiver are dropped before the event is dropped.

Panics

Panics if the event has already been bound to a sender-receiver pair.

Example

use events::OnceEvent;

let mut event = Box::pin(OnceEvent::<i32>::new());
// SAFETY: We ensure the event is pinned and outlives the sender and receiver
let (sender, receiver) = unsafe { event.as_ref().bind_by_ptr() };

sender.send(42);
let value = receiver.await.unwrap();
assert_eq!(value, 42);
// sender and receiver are dropped here, before event

pub unsafe fn bind_by_ptr_checked( self: Pin<&Self>, ) -> Option<(OnceSender<PtrEvent<T>>, OnceReceiver<PtrEvent<T>>)>

Returns both the sender and receiver for this event, connected by a raw pointer to the event.

Returns None if the event has already been bound to a sender-receiver pair.

This method requires the event to be pinned when called.

Safety

The caller must ensure that:

• The event remains alive and pinned for the entire lifetime of the sender and receiver.
• The sender and receiver are dropped before the event is dropped.

Example

use std::pin::Pin;

use events::OnceEvent;

let mut event = Box::pin(OnceEvent::<i32>::new());
// SAFETY: We ensure the event outlives the sender and receiver
let endpoints = unsafe { event.as_ref().bind_by_ptr_checked() }.unwrap();
let endpoints2 = unsafe { event.as_ref().bind_by_ptr_checked() }; // Returns None
assert!(endpoints2.is_none());

pub unsafe fn bind_by_ptr_unchecked( self: Pin<&Self>, ) -> (OnceSender<PtrEvent<T>>, OnceReceiver<PtrEvent<T>>)

Returns both the sender and receiver for this event, connected by a raw pointer to the event.

This method assumes the event is not already bound and skips the check for performance.

This method requires the event to be pinned when called.

Safety

The caller must ensure that:

• The event is not already bound.
• The event remains alive and pinned for the entire lifetime of the sender and receiver.
• The sender and receiver are dropped before the event is dropped.

Example

use events::OnceEvent;

let mut event = Box::pin(OnceEvent::<i32>::new());
// SAFETY: We ensure the event outlives the sender and receiver
let (sender, receiver) = unsafe { event.as_ref().bind_by_ptr_unchecked() };

pub fn inspect_awaiter(&self, f: impl FnOnce(Option<&Backtrace>))

Uses the provided closure to inspect the backtrace of the current awaiter, if there is an awaiter and if backtrace capturing is enabled.

This method is only available in debug builds (cfg(debug_assertions)). For any data to be present, RUST_BACKTRACE=1 or RUST_LIB_BACKTRACE=1 must be set.

The closure receives None if no one is awaiting the event.

Trait Implementations

impl<T> Clone for RefEvent<'_, T>

where T: Send,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for RefEvent<'a, T>

where T: Send + Debug,

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

Formats the value using the given formatter.

impl<T> Deref for RefEvent<'_, T>

where T: Send,

type Target = OnceEvent<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Send> ReflectiveTSend for RefEvent<'_, T>

type T = T

The type T extracted from the type signature.

impl<'a, T> Copy for RefEvent<'a, T>

where T: Send + Copy,

impl<T> EventRef<T> for RefEvent<'_, T>

where T: Send,