Struct AbortController

pub struct AbortController { /* private fields */ }

AbortController is a controller that allows you to monitor for a stream reset and cancel an associated asynchronous task if the reset occurs.

Implementations

impl AbortController

pub fn poll_reset(&mut self, cx: &mut Context<'_>) -> Poll<()>

Polls to be notified when the client resets this rpc. If the stream has not been reset. This returns Poll::Pending

pub async fn reset(&mut self)

Awaits the stream reset event.

pub async fn abort_on_reset(self, task: impl Future)

Executes a given asynchronous task and aborts it when stream is reset.

Example

controller.abort_on_reset(async {  }).await;

pub fn spawn_and_abort_on_reset<F>(self, task: F) -> JoinHandle<()>

where F: Future + Send + 'static,

Spawns a new task that will be aborted if the stream is reset.

This function spawns the given task in background, and automatically cancels the task if the stream reset event occurs.

Example

controller.spawn_and_abort_on_reset(async { ... });