Module apalis::prelude

Common imports

Re-exports

• pub use crate::utils::TokioExecutor;

Structs

• AddExtension
  Middleware for adding some shareable value to [request data].
• Attempt
  A wrapper to keep count of the attempts tried by a task
• BackendStream
  BackendStream is a wrapper around another stream S. It controls the flow of the stream based on the Controller state.
• Context
  Stores the Workers context
• Controller
  The Controller struct represents a thread-safe state manager. It uses AtomicUsize for state to ensure safe concurrent access. Used to control polling
• Data
  Extension data for tasks. This is commonly used to share state across tasks. or across layers within the same tasks
• Extensions
  A type map of protocol extensions.
• FetchNext
  Tells the poller that the worker is ready for a new request
• MemoryStorage
  An example of the basics of a backend
• MemoryWrapper
  In-memory queue that implements Stream
• Monitor
  A monitor for coordinating and managing a collection of workers.
• MonitorContext
  The internal context of a Monitor Usually shared with multiple workers
• Notify
  The Notify struct encapsulates asynchronous, multi-producer, single-consumer (MPSC) channel functionality. It is used to send notifications of type T from multiple producers to a single consumer.
• Poller
  A poller type that allows fetching from a stream and a heartbeat future that can be used to do periodic tasks
• Ready
  A worker that is ready for running
• Request
  Represents a job which can be serialized and executed
• ServiceFn
  An executable service implemented by a closure.
• TaskId
  A wrapper type that defines a task id.
• Worker
  Represents a generic Worker that can be in many different states
• WorkerBuilder
  Allows building a Worker. Usually the output is Worker<Ready>
• WorkerId
  A worker name wrapper usually used by Worker builder

Enums

• Error
  Represents a general error returned by a task or by internals of the platform
• Event
  Events emitted by a worker
• WorkerError
  Possible errors that can occur when starting a worker.

Traits

• Backend
  A backend represents a task source Both Storage and MessageQueue need to implement it for workers to be able to consume tasks
• Codec
  This allows encoding and decoding of requests in different backends
• Executor
  An Executor that is used to spawn futures
• FromData
  Allows getting some type from the Request data
• IntoResponse
  Helper for Job Responses
• Job
  Trait representing a job.
• Message
  Trait representing a job.
• MessageQueue
  Represents a message queue that can be pushed and consumed.
• Storage
  Represents a Storage that can persist a request. The underlying type must implement Job
• WorkerFactory
  Helper trait for building new Workers from WorkerBuilder
• WorkerFactoryFn
  Helper trait for building new Workers from WorkerBuilder

Functions

• service_fn
  A helper method to build functions

Type Aliases

• BoxDynError
  Convenience type alias
• RequestStream
  Represents a stream for T.
• StorageStream
  The result of sa stream produced by a Storage