Struct tokio_postgres::CancelToken
source · pub struct CancelToken { /* private fields */ }
Expand description
The capability to request cancellation of in-progress queries on a connection.
Implementations§
source§impl CancelToken
impl CancelToken
sourcepub async fn cancel_query<T>(&self, tls: T) -> Result<(), Error>where
T: MakeTlsConnect<Socket>,
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).
sourcepub async fn cancel_query_raw<S, T>(
&self,
stream: S,
tls: T
) -> Result<(), Error>where
S: AsyncRead + AsyncWrite + Unpin,
T: TlsConnect<S>,
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§
source§impl Clone for CancelToken
impl Clone for CancelToken
source§fn clone(&self) -> CancelToken
fn clone(&self) -> CancelToken
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations§
impl RefUnwindSafe for CancelToken
impl Send for CancelToken
impl Sync for CancelToken
impl Unpin for CancelToken
impl UnwindSafe for CancelToken
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more