Struct madsim_tokio_postgres::CancelToken
source · [−]pub struct CancelToken { /* private fields */ }
Expand description
The capability to request cancellation of in-progress queries on a connection.
Implementations
sourceimpl 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
sourceimpl Clone for CancelToken
impl Clone for CancelToken
sourcefn clone(&self) -> CancelToken
fn clone(&self) -> CancelToken
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl RefUnwindSafe for CancelToken
impl Send for CancelToken
impl Sync for CancelToken
impl Unpin for CancelToken
impl UnwindSafe for CancelToken
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more