Skip to main content

TaskState

Struct TaskState 

Source
pub struct TaskState { /* private fields */ }
Expand description

An owned duckdb_task_state that drives a database’s task execution.

Holds the database Arc so the underlying database outlives the state.

Implementations§

Source§

impl TaskState

Source

pub fn new(db: &Database) -> TaskState

Creates a task state for db.

Source

pub fn execute(&self)

Executes pending tasks on the calling thread until finish is signalled. Intended to be run on a dedicated worker thread (and may be run on several threads sharing this state).

Source

pub fn execute_n(&self, max_tasks: u64) -> u64

Executes up to max_tasks pending tasks on the calling thread, returning how many actually ran. Stops early if finish is signalled or there are no more tasks.

Source

pub fn finish(&self)

Signals every execute_* call on this state to stop.

Source

pub fn is_finished(&self) -> bool

Whether finish has been signalled on this state.

Trait Implementations§

Source§

impl Drop for TaskState

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Send for TaskState

Source§

impl Sync for TaskState

Auto Trait Implementations§

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> 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, 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.