Skip to main content

Module prelude

Module prelude 

Source
Expand description

Common imports re-exported for convenience.

Macros§

define_commands
define_commands_server
define_commands_web

Structs§

CliProgress
Display command progress as a terminal progress bar.
CommandEventCounts
Aggregate counts of command lifecycle events.
CommandEvents
Collect and query command lifecycle events.
CommandMediator
A mediator between the CommandRunner, Worker and CliProgress services.
CommandProgress
Snapshot of command queue progress.
CommandRegistry
Map request types to their handlers.
CommandRunner
Queue and execute commands across a pool of workers.
Worker
A worker that executes commands
WorkerPool
Manage a dynamic set of Worker instances.

Enums§

CommandStatus
Current state of a queued command.
EventKind
Lifecycle stage of a command.
Instruction
An instruction sent to a Worker.
QueueError
Errors returned by CommandRegistry::resolve.
RunnerStatus
Current state of the CommandRunner.

Traits§

Executable
A request that can be executed by a handler.
Execute
Handle execution of a request.
ICommand
A command that pairs a request with its handler for execution.
ICommandInfo
Associated types that define a complete command system.
IEvent
A command lifecycle event carrying the request and optional success data.
IFailure
Marker trait for command failure enums.
IHandler
Marker trait for command handler enums generated by define_commands_server.
IRequest
Marker trait for serializable command request enums.
ISuccess
Marker trait for serializable command success enums.
RegisterHandlers
Describe how to populate a CommandRegistry for a command system.

Type Aliases§

WorkerId
Unique identifier for a Worker.