Struct CancelHandle 

pub struct CancelHandle<T>
where
    T: AsyncRead + AsyncWrite,
{ /* private fields */ }

Handle for cancelling queries on a connection.

This can be cloned and sent to other tasks to enable cancellation from a different async context.

Implementations

impl<T> CancelHandle<T>

where T: AsyncRead + AsyncWrite + Unpin,

pub async fn cancel(&self) -> Result<(), CodecError>

Send an Attention packet to cancel the current query.

This can be called from a different task while the main task is blocked reading results.

pub async fn wait_cancelled(&self)

Wait for the cancellation to complete.

This waits until the server acknowledges the cancellation with a DONE token containing the ATTENTION flag.

pub fn is_cancelling(&self) -> bool

Check if a cancellation is currently in progress.

Trait Implementations

impl<T> Clone for CancelHandle<T>

where T: AsyncRead + AsyncWrite,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for CancelHandle<T>

where T: AsyncRead + AsyncWrite + Unpin,

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

Formats the value using the given formatter.