Skip to main content

KeepAwakeTask

Struct KeepAwakeTask 

Source
pub struct KeepAwakeTask { /* private fields */ }
Expand description

A keepalive running as a background task. Dropping it stops the task.

Implementations§

Source§

impl KeepAwakeTask

Source

pub fn is_running(&self) -> bool

Whether the task is still polling.

Source

pub fn request_stop(&self)

Asks the task to stop. Idempotent; Self::finished waits for it.

Source

pub async fn finished(&self) -> Result<KeepAwakeReport, Error>

Waits for the task to end and returns its report, or the error that ended it.

Callable any number of times, from any number of waiters.

Source

pub fn outcome(&self) -> Option<Result<KeepAwakeReport, Error>>

The report, once the task has ended.

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> Same for T

Source§

type Output = T

Should always be Self
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.