Struct bastion::supervisor::RestartStrategy

pub struct RestartStrategy { /* fields omitted */ }

The strategy for a supervisor which is used for restoring failed actors. It it fails after N attempts, the supervisor will remove an actor.

The default strategy used is ActorRestartStrategy::Immediate with the RestartPolicy::Always restart policy.

Implementations

impl RestartStrategy

pub fn new(
    restart_policy: RestartPolicy,
    strategy: ActorRestartStrategy
) -> Self

Creates a new instance of RestartStrategy.

Arguments

• restart_policy - Defines a restart policy to use for failed actor:

  • RestartPolicy::Always would restart the failed actor each time as it fails.
  • RestartPolicy::Never would not restart the failed actor and remove it from tracking.
  • RestartPolicy::Tries would restart the failed actor a limited amount of times. If can’t be started, then will remove it from tracking.

• strategy - The strategy to use:

  • ActorRestartStrategy::Immediate would restart the failed actor as soon as possible.
  • ActorRestartStrategy::LinearBackOff would restart the failed actor with the delay increasing linearly.
  • ActorRestartStrategy::ExponentialBackOff would restart the failed actor with the delay, multiplied by given coefficient.

Example

let actor_restart_strategy = ActorRestartStrategy::LinearBackOff {
    timeout: Duration::from_secs(5)
};
let restart_strategy = RestartStrategy::default()
    .with_actor_restart_strategy(actor_restart_strategy);

pub fn restart_policy(&self) -> RestartPolicy

Returns the acceptable count of retries for the failed actor. The None value means the amount of attempts is unlimited.

pub fn strategy(&self) -> ActorRestartStrategy

Returns the current strategy for restarting failed actors.

pub fn with_restart_policy(self, restart_policy: RestartPolicy) -> Self

Sets the limit of attempts for restoring failed actors.

pub fn with_actor_restart_strategy(self, strategy: ActorRestartStrategy) -> Self

Sets the actor restart strategy the supervisor should use of its supervised children groups or supervisors dies to restore in the correct state.

Trait Implementations

impl Clone for RestartStrategy

fn clone(&self) -> RestartStrategy

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RestartStrategy

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RestartStrategy

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<RestartStrategy> for RestartStrategy

fn eq(&self, other: &RestartStrategy) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RestartStrategy) -> bool

This method tests for !=.

impl StructuralPartialEq for RestartStrategy