Struct actix::prelude::Supervisor [−][src]
pub struct Supervisor<A> where
A: Supervised + Actor<Context = Context<A>>, { /* fields omitted */ }
Expand description
Actor supervisor
A Supervisor manages incoming messages for an actor. In case of actor failure,
the supervisor creates a new execution context and restarts the actor’s lifecycle.
A Supervisor does not re-create their actor, it just calls the restarting()
method.
Supervisors have the same lifecycle as actors. If all addresses to a supervisor gets dropped and its actor does not execute anything, the supervisor terminates.
Supervisors can not guarantee that their actors successfully processes incoming
messages. If the actor fails during message processing, the message can not be
recovered. The sender would receive an Err(Cancelled)
error in this situation.
Example
#[derive(Message)]
#[rtype(result = "()")]
struct Die;
struct MyActor;
impl Actor for MyActor {
type Context = Context<Self>;
}
// To use actor with supervisor actor has to implement `Supervised` trait
impl actix::Supervised for MyActor {
fn restarting(&mut self, ctx: &mut Context<MyActor>) {
println!("restarting");
}
}
impl Handler<Die> for MyActor {
type Result = ();
fn handle(&mut self, _: Die, ctx: &mut Context<MyActor>) {
ctx.stop();
}
}
fn main() {
let sys = System::new("example");
let addr = actix::Supervisor::start(|_| MyActor);
addr.do_send(Die);
sys.run();
}
Implementations
Start new supervised actor in current tokio runtime.
Type of returned address depends on variable type. For example to get
Addr<Syn, _>
of newly created actor, use explicitly Addr<Syn, _>
type as type of a variable.
struct MyActor;
impl Actor for MyActor {
type Context = Context<Self>;
}
// Get `Addr` of a MyActor actor
let addr = actix::Supervisor::start(|_| MyActor);
Trait Implementations
impl<'pin, A> Unpin for Supervisor<A> where
A: Supervised + Actor<Context = Context<A>>,
__Supervisor<'pin, A>: Unpin,
Auto Trait Implementations
impl<A> !RefUnwindSafe for Supervisor<A>
impl<A> !Send for Supervisor<A>
impl<A> !Sync for Supervisor<A>
impl<A> !UnwindSafe for Supervisor<A>
Blanket Implementations
Mutably borrows from an owned value. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
Map this future’s output to a different type, returning a new future of the resulting type. Read more
Chain on a computation for when a future finished, passing the result of
the future to the provided closure f
. Read more
Wrap this future in an Either
future, making it the left-hand variant
of that Either
. Read more
Wrap this future in an Either
future, making it the right-hand variant
of that Either
. Read more
Convert this future into a single element stream. Read more
Flatten the execution of this future when the output of this future is itself another future. Read more
Flatten the execution of this future when the successful result of this future is a stream. Read more
Fuse a future such that poll
will never again be called once it has
completed. This method can be used to turn any Future
into a
FusedFuture
. Read more
Do something with the output of a future before passing it on. Read more
fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<Fut>impl<Fut> Future for CatchUnwind<Fut> where
Fut: Future + UnwindSafe, type Output = Result<<Fut as Future>::Output, Box<dyn Any + Send + 'static, Global>>;
where
Self: UnwindSafe,
fn catch_unwind(self) -> CatchUnwind<Self>ⓘNotable traits for CatchUnwind<Fut>impl<Fut> Future for CatchUnwind<Fut> where
Fut: Future + UnwindSafe, type Output = Result<<Fut as Future>::Output, Box<dyn Any + Send + 'static, Global>>;
where
Self: UnwindSafe,
impl<Fut> Future for CatchUnwind<Fut> where
Fut: Future + UnwindSafe, type Output = Result<<Fut as Future>::Output, Box<dyn Any + Send + 'static, Global>>;
Catches unwinding panics while polling the future. Read more
Create a cloneable handle to this future where all handles will resolve to the same result. Read more
Turn this future into a future that yields ()
on completion and sends
its output to another future on a separate task. Read more
Wrap the future in a Box, pinning it. Read more
Wrap the future in a Box, pinning it. Read more
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = ()
>. Read more
fn never_error(self) -> NeverError<Self>ⓘNotable traits for NeverError<Fut>impl<Fut> Future for NeverError<Fut> where
Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;
fn never_error(self) -> NeverError<Self>ⓘNotable traits for NeverError<Fut>impl<Fut> Future for NeverError<Fut> where
Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;
impl<Fut> Future for NeverError<Fut> where
Map<Fut, OkFn<Infallible>>: Future, type Output = <Map<Fut, OkFn<Infallible>> as Future>::Output;
Turns a Future<Output = T>
into a
TryFuture<Ok = T, Error = Never
>. Read more
A convenience for calling Future::poll
on Unpin
future types.
Evaluates and consumes the future, returning the resulting output if
the future is ready after the first call to Future::poll
. Read more
into_future
)The output that the future will produce on completion.
type Future = F
type Future = F
into_future
)Which kind of future are we turning this into?
into_future
)Creates a future from a value.
type Future = FutureWrap<F, A>
type Future = FutureWrap<F, A>
The future that this type can be converted into.
Convert normal future to a ActorFuture