TimeEventCallback

Enum TimeEventCallback 

Source
pub enum TimeEventCallback {
    Python(Py<PyAny>),
    Rust(Arc<dyn Fn(TimeEvent) + Send + Sync>),
    RustLocal(Rc<dyn Fn(TimeEvent)>),
}
Expand description

Callback type for time events.

§Variants

  • Python: For Python callbacks (requires python feature).
  • Rust: Thread-safe callbacks using Arc. Use when the closure is Send + Sync.
  • RustLocal: Single-threaded callbacks using Rc. Use when capturing Rc<RefCell<...>>.

§Choosing Between Rust and RustLocal

Use Rust (thread-safe) when:

  • The callback doesn’t capture Rc<RefCell<...>> or other non-Send types.
  • The closure is Send + Sync (most simple closures qualify).

Use RustLocal when:

  • The callback captures Rc<RefCell<...>> for shared mutable state.
  • Thread safety constraints prevent using Arc.

Both variants work with TestClock and LiveClock. The RustLocal variant is safe with LiveClock because callbacks are sent through a channel and executed on the originating thread’s event loop - they never actually cross thread boundaries.

§Automatic Conversion

  • Closures that are Fn + Send + Sync + 'static automatically convert to Rust.
  • Rc<dyn Fn(TimeEvent)> converts to RustLocal.
  • Arc<dyn Fn(TimeEvent) + Send + Sync> converts to Rust.

Variants§

§

Python(Py<PyAny>)

Python callable for use from Python via PyO3.

§

Rust(Arc<dyn Fn(TimeEvent) + Send + Sync>)

Thread-safe Rust callback using Arc (Send + Sync).

§

RustLocal(Rc<dyn Fn(TimeEvent)>)

Local Rust callback using Rc (not Send/Sync).

Implementations§

Source§

impl TimeEventCallback

Source

pub const fn is_rust(&self) -> bool

Returns true if this is a thread-safe Rust callback.

Source

pub const fn is_local(&self) -> bool

Returns true if this is a local (non-thread-safe) Rust callback.

Local callbacks use Rc internally. They work with both TestClock and LiveClock since callbacks are executed on the originating thread.

Source

pub fn call(&self, event: TimeEvent)

Invokes the callback for the given TimeEvent.

For Python callbacks, exceptions are logged as errors rather than panicking.

Trait Implementations§

Source§

impl Clone for TimeEventCallback

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TimeEventCallback

Source§

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

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

impl From<Arc<dyn Fn(TimeEvent) + Send + Sync>> for TimeEventCallback

Source§

fn from(value: Arc<dyn Fn(TimeEvent) + Send + Sync>) -> Self

Converts to this type from the input type.
Source§

impl<F> From<F> for TimeEventCallback
where F: Fn(TimeEvent) + Send + Sync + 'static,

Source§

fn from(value: F) -> Self

Converts to this type from the input type.
Source§

impl From<Py<PyAny>> for TimeEventCallback

Available on crate feature python only.
Source§

fn from(value: Py<PyAny>) -> Self

Converts to this type from the input type.
Source§

impl From<Rc<dyn Fn(TimeEvent)>> for TimeEventCallback

Source§

fn from(value: Rc<dyn Fn(TimeEvent)>) -> Self

Converts to this type from the input type.
Source§

impl Send for TimeEventCallback

Source§

impl Sync for TimeEventCallback

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.

§

impl<T> Instrument for T

§

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

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

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

Source§

type Output = T

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

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> Ungil for T
where T: Send,