Struct AsyncJob 

pub struct AsyncJob<T = AnyCallback> { /* private fields */ }

An awaitable JobID. AsyncJob is untyped, AsyncJob<T> typed.

Implementations

impl<T> AsyncJob<T>

pub fn new(job_id: JobID) -> AsyncJob<T>

Creates a job. Register it with the job manager by handing over its sender (AsyncJob::take_sender).

pub fn job_id(&self) -> JobID

The JobID of this job.

pub fn timeout(&self) -> Duration

How long until this job times out and is cancelled. 10 seconds by default.

pub fn set_timeout(&mut self, timeout: Duration)

Sets how long until this job times out and is cancelled.

pub fn is_timedout(&self) -> bool

Whether this job has timed out.

pub fn heartbeat(&mut self)

Records a heartbeat and extends the job’s timeout.

pub fn add_result(&mut self, callback: Box<dyn CallbackMsg>) -> bool

Adds a callback to the job’s results. For the untyped job, one callback always completes it.

pub fn set_failed(&mut self, due_to_remote_failure: bool)

Fails the job: due_to_remote_failure if Steam reported a failure, otherwise it timed out.

pub fn take_sender( &mut self, ) -> Option<Sender<Result<Box<dyn CallbackMsg>, SteamError>>>

Hands the sending half of the completion channel to the job manager, which completes the job when the matching callback arrives.

pub fn into_receiver(self) -> JobReceiver

Takes the receiving half of the completion channel.

impl<T: CallbackMsg> AsyncJob<T>

pub fn to_task(self) -> TypedJobReceiver<T>

Converts this job into its awaitable form.

pub async fn wait(self) -> Result<T, SteamError>

Waits for the job’s result.

Trait Implementations

impl<T> Debug for AsyncJob<T>

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

Formats the value using the given formatter.

impl<T> From<&AsyncJob<T>> for JobID

fn from(job: &AsyncJob<T>) -> JobID

Converts to this type from the input type.