Struct tokio_postgres::CancelToken

pub struct CancelToken { /* fields omitted */ }

The capability to request cancellation of in-progress queries on a connection.

Implementations

impl CancelToken

pub async fn cancel_query<T>(&self, tls: T) -> Result<(), Error> where
    T: MakeTlsConnect<Socket>, 

Attempts to cancel the in-progress query on the connection associated with this CancelToken.

The server provides no information about whether a cancellation attempt was successful or not. An error will only be returned if the client was unable to connect to the database.

Cancellation is inherently racy. There is no guarantee that the cancellation request will reach the server before the query terminates normally, or that the connection associated with this token is still active.

Requires the runtime Cargo feature (enabled by default).

pub async fn cancel_query_raw<S, T>(
    &self,
    stream: S,
    tls: T
) -> Result<(), Error> where
    S: AsyncRead + AsyncWrite + Unpin,
    T: TlsConnect<S>, 

Like cancel_query, but uses a stream which is already connected to the server rather than opening a new connection itself.

Trait Implementations

impl Clone for CancelToken

fn clone(&self) -> CancelToken

Returns a copy of the value.

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

Performs copy-assignment from source.