Skip to main content

TimeEventCallback

Enum TimeEventCallback 

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

Represents a callback invoked 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 does not 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.

RustLocal works with TestClock and with LiveClock when its event channel is drained on the callback’s originating thread.

§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(Arc<PythonTimeEventCallback>)

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_local(&self) -> bool

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

Local callbacks use Rc internally and require creation, cloning, dropping, and invocation to stay 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.

§Panics

Panics from Rust callbacks propagate to the caller.

Source§

impl TimeEventCallback

Source

pub fn from_python_time_event(callback: Py<PyAny>) -> Self

Creates a Python callback that receives a PyO3 TimeEvent.

Trait Implementations§

Source§

impl Clone for TimeEventCallback

Source§

fn clone(&self) -> TimeEventCallback

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

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
§

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

§

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

§

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> 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 = !

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<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