Enum AutoSleep 

pub enum AutoSleep {
    Automatic,
    NotBefore(Duration),
    Never,
}

When Sail may put a Sailbox to sleep on its own.

Sail watches for Sailboxes that are doing nothing and sleeps them, freeing their memory and waking them the moment anything needs them again. Waking takes a couple of seconds, which is free for a batch job and unwelcome if someone is waiting at a terminal.

Every choice here can only make Sail sleep the Sailbox less often than it otherwise would. None of them can cause a sleep, and Sail still sleeps a Sailbox only when it sits fully idle: no busy process, no imminent timer, nothing a sleep would interrupt.

Calling sleep yourself is unaffected, and so are pause, resume, and scheduled wakes.

Variants

Automatic

Sail decides, on its own timing. The default.

NotBefore(Duration)

Sail decides, but waits at least this long first. A duration shorter than Sail’s own wait is accepted and simply has no effect; anything longer holds the Sailbox awake for that much idle time. A wait longer than an hour is rejected; use Never instead.

Never

Sail never sleeps this Sailbox on its own.

Trait Implementations

impl Clone for AutoSleep

fn clone(&self) -> AutoSleep

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for AutoSleep

impl Debug for AutoSleep

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

Formats the value using the given formatter.

impl Default for AutoSleep

fn default() -> AutoSleep

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AutoSleep

fn deserialize<D: Deserializer<'de>>( deserializer: D, ) -> Result<AutoSleep, D::Error>

Deserialize this value from the given Serde deserializer.

impl Eq for AutoSleep

impl PartialEq for AutoSleep

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AutoSleep

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AutoSleep