Skip to main content

IdleHost

Struct IdleHost 

Source
pub struct IdleHost {
    pub suspend_after: Duration,
    pub options: IdleOptions,
    pub minimize: MinimizeTracker,
    pub state: Mutex<IdleState>,
    pub counters: Mutex<(u32, u32)>,
    pub on_error: Option<IdleErrorCallback>,
    pub on_transition: Option<IdleTransitionCallback>,
    /* private fields */
}
Expand description

Runtime half kept in ShellState.

Fields§

§suspend_after: Duration§options: IdleOptions§minimize: MinimizeTracker§state: Mutex<IdleState>§counters: Mutex<(u32, u32)>

How many times the platform suspend / resume action succeeded (diagnostics, QA).

§on_error: Option<IdleErrorCallback>

Receives platform suspend / resume failures. None keeps them silent (the default).

§on_transition: Option<IdleTransitionCallback>

Receives suspended / resumed transitions. None (the default) changes nothing.

Implementations§

Source§

impl IdleHost

Source

pub fn new(suspend_after: Duration) -> Self

Source

pub fn with_options(self, options: IdleOptions) -> Self

Replace the options; the timeout follows options.suspend_after.

Source

pub fn with_on_error(self, on_error: Option<IdleErrorCallback>) -> Self

Install (or clear, with None) the failure callback.

Source

pub fn with_on_transition( self, on_transition: Option<IdleTransitionCallback>, ) -> Self

Install (or clear, with None) the transition callback.

Source

pub fn report_failure(&self, phase: IdlePhase, window: &str, error: &str)

Deliver a failure to the callback, if one is installed. Platform code and tests use this.

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.