pub struct InterruptHandle<'a> { /* private fields */ }Expand description
A cancellation handle for an OwnedConnection, usable from another thread.
Both operations reach DuckDB through atomics — ClientContext::interrupted
is an atomic<bool>, and every field of QueryProgress is an atomic — so
this is Send + Sync. The borrow of the connection is what keeps it sound:
the handle cannot outlive the duckdb_disconnect in
OwnedConnection’s Drop.
§Example
use std::sync::mpsc::{channel, RecvTimeoutError};
use std::time::Duration;
let watchdog = con.interrupt_handle();
let (done, finished) = channel::<()>();
std::thread::scope(|scope| {
// Cancels the query only if it is still running after 30 s; returns
// as soon as it finishes.
scope.spawn(move || {
if finished.recv_timeout(Duration::from_secs(30)) == Err(RecvTimeoutError::Timeout) {
watchdog.cancel();
}
});
let result = con.query("SELECT count(*) FROM huge_table");
drop(done);
result
})?;Implementations§
Source§impl InterruptHandle<'_>
impl InterruptHandle<'_>
Sourcepub fn progress(&self) -> QueryProgress
pub fn progress(&self) -> QueryProgress
Reads the progress of the query currently running on the connection.
percentage is -1.0 whenever DuckDB cannot say — see
QueryProgress for when that is, which on 1.x includes a whole
query whose pipelines do not all report progress.
Trait Implementations§
Source§impl<'a> Clone for InterruptHandle<'a>
impl<'a> Clone for InterruptHandle<'a>
Source§fn clone(&self) -> InterruptHandle<'a>
fn clone(&self) -> InterruptHandle<'a>
Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreimpl<'a> Copy for InterruptHandle<'a>
Source§impl<'a> Debug for InterruptHandle<'a>
impl<'a> Debug for InterruptHandle<'a>
impl Send for InterruptHandle<'_>
impl Sync for InterruptHandle<'_>
Auto Trait Implementations§
impl<'a> Freeze for InterruptHandle<'a>
impl<'a> RefUnwindSafe for InterruptHandle<'a>
impl<'a> Unpin for InterruptHandle<'a>
impl<'a> UnsafeUnpin for InterruptHandle<'a>
impl<'a> UnwindSafe for InterruptHandle<'a>
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