Module workflow_rs::core::prelude

Expand description

The prelude module re-exports the most commonly used traits and types from the workflow_core crate.

Structs

Abortable
Abortable trigger wraps an Arc<AtomicBool>, which can be cloned to signal task terminating using an atomic bool.
Channel
Channel struct that combines async_std::channel::Sender and async_std::channel::Receiver into a single struct with sender and receiver members representing a single channel.
DuplexChannel
DuplexChannel contains 2 channels request and response meant to provide for a request/response pattern. This is useful for any type of signaling, but especially during task termination, where you can request a task to terminate and wait for a response confirming its termination.
Duration
A Duration type to represent a span of time, typically used for system timeouts.
Multiplexer
A simple MPMC (one to many) channel Multiplexer that broadcasts to multiple registered receivers. Multiplexer<T> itself can be cloned and used to broadcast using Multiplexer::broadcast() or Multiplexer::try_broadcast(). To create a receiving channel, you can call MultiplexerChannel<T>::from() and supply the desired Multiplexer instance, or simply call Multiplexer::channel() to create a new MultiplexerChannel instance. The receiving channel gets unregistered when MultiplexerChannel is dropped or the underlying Receiver is closed.
Sendable
Senable wrapper for JS primitives.

dispatch
interval
async interval() function backed by the JavaScript createInterval()
oneshot
Creates a oneshot channel (bounded channel with a limit of 1 message)
sleep
Waits until duration has elapsed.
spawn
unixtime_as_millis_f64
unixtime_as_millis_u128
yield_executor
Yields execution back to the Tokio runtime.
yield_now
Yields execution back to the Tokio runtime.

Describe
Attribute macro for automatic conversion of enums to their string representation