Struct KeepAwake 

pub struct KeepAwake { /* private fields */ }

A keepalive’s policy. Build with KeepAwake::new, check with KeepAwake::validate.

Implementations

impl KeepAwake

pub fn new(idle_window: Option<Duration>) -> KeepAwake

A keepalive for a VM whose maxIdleDurationSeconds is idle_window, or the platform minimum when unknown. The interval defaults to a third of the window, at most DEFAULT_KEEP_AWAKE_INTERVAL.

pub fn interval(self, interval: Duration) -> KeepAwake

pub fn while_busy(self, while_busy: bool) -> KeepAwake

End once the daemon reports no running exec.

pub fn max_duration(self, max_duration: Option<Duration>) -> KeepAwake

End after this long even if still busy.

pub fn tolerated_errors(self, tolerated_errors: u32) -> KeepAwake

pub fn interval_value(&self) -> Duration

pub fn idle_window_value(&self) -> Duration

pub fn validate(&self) -> Result<(), Error>

Refuses a policy that could let the VM suspend. See the module docs for the cap.

pub async fn run<P, F, S>( &self, probe: P, stop: S, ) -> Result<KeepAwakeReport, Error>

where P: FnMut() -> F, F: Future<Output = Result<Option<Health>, Error>>, S: Future<Output = ()>,

Polls probe until stop resolves, the policy ends it, or a poll fails for good.

The first poll is immediate. probe answers Ok(None) when the VM is no longer running. A retryable failure is retried after one second, up to tolerated_errors in a row; any other failure ends the keepalive with that error.

impl KeepAwake

pub fn spawn( self, session: Session, running: Option<Box<dyn Fn() -> bool + Send + Sync>>, ) -> Result<KeepAwakeTask, Error>

Validates the policy and starts polling session on the current tokio runtime.

running, when given, is checked before every poll; once it answers false the task ends with KeepAwakeEnd::NotRunning without polling again. Panics outside a tokio runtime, like tokio::spawn.

Trait Implementations

impl Clone for KeepAwake

fn clone(&self) -> KeepAwake

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeepAwake

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

Formats the value using the given formatter.