Crate actix[−][src]
Actix is an actor framework.
Actors are
objects which encapsulate state and behavior, they communicate
exclusively by exchanging messages. Actix actors are implemented
on top of Tokio. Multiple actors can run in
same thread. Actors can run in multiple threads using the
Arbiter
API. Actors exchange typed
messages.
Other Documentation
Features
- Async/Sync actors
- Actor communication in a local/thread context
- Using Futures for asynchronous message handling
- Actor supervision
- Typed messages (No
Any
type). Generic messages are allowed - Runs on stable Rust 1.40+
Package feature
resolver
- enables DNS resolver actor; see resolver module
Re-exports
pub use crate::fut::ActorFuture; |
pub use crate::fut::ActorFutureExt; |
pub use crate::fut::ActorStream; |
pub use crate::fut::ActorStreamExt; |
pub use crate::fut::WrapFuture; |
pub use crate::fut::WrapStream; |
pub use crate::registry::ArbiterService; |
pub use crate::registry::Registry; |
pub use crate::registry::SystemRegistry; |
pub use crate::registry::SystemService; |
pub use crate::sync::SyncArbiter; |
pub use crate::sync::SyncContext; |
Modules
actors | Helper actors |
clock | Utilities for tracking time. |
dev | The |
fut | Custom |
io | |
prelude | The |
registry | Actors registry |
sync | Sync Actors support |
utils |
Structs
ActorResponse | A helper type for representing different types of message responses. |
Addr | The address of an actor. |
Arbiter | An Arbiter represents a thread that provides an asynchronous execution environment for futures and functions. |
ArbiterHandle | A handle for sending spawn and stop messages to an Arbiter. |
AtomicResponse | A specialized actor future holder for atomic asynchronous message handling. |
Context | An actor execution context. |
MessageResult | A helper type that implements the |
Recipient | The |
Response | Helper type for representing different type of message responses |
SpawnHandle | A handle to a spawned future. |
Supervisor | Actor supervisor |
System | A manager for a per-thread distributed async runtime. |
SystemRunner | Runner that keeps a System’s event loop alive until stop message is received. |
WeakAddr | A weakly referenced counterpart to |
WeakRecipient | A weakly referenced counterpart to |
Enums
ActorState | Actor execution state |
MailboxError | The errors that can occur during the message delivery process. |
Running |
Traits
Actor | Actors are objects which encapsulate state and behavior. |
ActorContext | Actor execution context. |
AsyncContext | Asynchronous execution context. |
Handler | Describes how to handle messages of a specific type. |
Message | Represent message that can be handled by an actor. |
StreamHandler | Stream handling for Actors. |
Supervised | Actors with the ability to restart after failure. |
Functions
run | Starts the system and executes the supplied future. |
spawn | Spawns a future on the current thread. |
Type Definitions
ResponseActFuture | A specialized actor future for asynchronous message handling. |
ResponseFuture | A specialized future for asynchronous message handling. |
Attribute Macros
main | Marks async function to be executed by Actix system. |
test | Marks async test function to be executed by Actix system. |
Derive Macros
Message | |
MessageResponse |