RestartPolicy

Enum RestartPolicy 

Source
pub enum RestartPolicy {
    Never,
    Always {
        delay_secs: Option<u32>,
    },
    OnFailure {
        delay_secs: Option<u32>,
    },
    OnSuccess {
        delay_secs: Option<u32>,
    },
}
Expand description

Represents the restart policy for a service.

This enum provides a cross-platform abstraction for service restart behavior with a set of simple options that cover most service managers.

For most service cases you likely want a restart-on-failure policy, so this is the default.

Each service manager supports different levels of granularity:

  • Systemd (Linux): supports all variants natively
  • Launchd (macOS): supports Never, Always, OnFailure (approximated), and OnSuccess via KeepAlive dictionary
  • WinSW (Windows): supports Never, Always, and OnFailure; OnSuccess falls back to Always with a warning
  • OpenRC/rc.d/sc.exe: limited or no restart support as of yet

When a platform doesn’t support a specific policy, the implementation will fall back to the closest approximation and log a warning.

In the case where you need a restart policy that is very specific to a particular service manager, you should instantiate that service manager directly, rather than using the generic ServiceManager trait.

Variants§

§

Never

Never restart the service

§

Always

Always restart the service regardless of exit status.

The optional delay specifies seconds to wait before restarting.

Fields

§delay_secs: Option<u32>

Delay in seconds before restarting

§

OnFailure

Restart the service only when it exits with a non-zero status.

The optional delay specifies seconds to wait before restarting.

Fields

§delay_secs: Option<u32>

Delay in seconds before restarting

§

OnSuccess

Restart the service only when it exits with a zero status (success).

The optional delay specifies seconds to wait before restarting.

Fields

§delay_secs: Option<u32>

Delay in seconds before restarting

Trait Implementations§

Source§

impl Clone for RestartPolicy

Source§

fn clone(&self) -> RestartPolicy

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RestartPolicy

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RestartPolicy

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Hash for RestartPolicy

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RestartPolicy

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for RestartPolicy

Source§

impl Eq for RestartPolicy

Source§

impl StructuralPartialEq for RestartPolicy

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.