Skip to main content

InterruptHandle

Struct InterruptHandle 

Source
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<'_>

Source

pub fn cancel(&self)

Requests cancellation of the query currently running on the connection.

Source

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>

Source§

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)

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for InterruptHandle<'a>

Source§

impl<'a> Debug for InterruptHandle<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Send for InterruptHandle<'_>

Source§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.