Skip to main content

WriterTaskHandle

Struct WriterTaskHandle 

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

Sender half of the write queue. Cheaply cloneable (wraps an mpsc::Sender) — every migrated store that shares one writer task holds a clone of this handle.

Implementations§

Source§

impl WriterTaskHandle

Source

pub async fn send<R, F>(&self, op: F) -> Result<R, StorageError>
where R: Send + 'static, F: FnOnce(&Connection) -> Result<R, StorageError> + Send + 'static,

Send a write operation to the writer task and await its typed reply.

Backpressure: this suspends on the channel’s send().await when the bounded queue is full (ADR-067 “Channel capacity and queue-full policy”) — there is no try_send escape hatch. Callers that need a deadline on that wait should use Self::send_with_timeout instead.

Source

pub async fn send_with_timeout<R, F>( &self, op: F, timeout: Duration, ) -> Result<R, StorageError>
where R: Send + 'static, F: FnOnce(&Connection) -> Result<R, StorageError> + Send + 'static,

Like Self::send, but bounds the wait for the bounded channel to free capacity with timeout.

The timeout applies ONLY to enqueueing the request (the channel send().await that can suspend on a full queue) — never to waiting for the writer task’s reply once the request has been accepted. StorageError::WriteQueueFull means exactly “the bounded channel was full and this request was never accepted”; it must never be returned for a request that was accepted and is still executing (or already committed) by the time timeout elapses — that would misreport a slow op or a lock wait as a queue-capacity failure, and could tell a caller a write failed when it actually landed. ADR-067’s queue-full policy has no immediate-error try_send path — only this caller-side deadline on the enqueue step.

Source

pub async fn send_top_level<R, F>(&self, op: F) -> Result<R, StorageError>
where R: Send + 'static, F: FnOnce(&Connection) -> Result<R, StorageError> + Send + 'static,

Send a write operation that MUST run outside any open transaction (e.g. VACUUM, which SQLite forbids inside BEGIN/COMMIT) and await its typed reply.

Still serialized through the same single writer owner as Self::send — the request goes through the identical bounded channel and drain loop, one request at a time — but the drain loop skips the per-request BEGIN IMMEDIATE/COMMIT/ROLLBACK wrap entirely for this request (ADR-067 Component A). The single-writer guarantee is preserved; only the transaction wrap is skipped.

Source

pub fn queue_depth(&self) -> usize

Current write-queue backlog depth: requests enqueued but not yet accepted by the writer task’s drain loop.

Reads mpsc::Sender::max_capacity() - capacity(), so it is a point-in-time snapshot racy under concurrent senders/the drain loop draining concurrently — acceptable for a monitoring gauge (the load/perf harness metrics read-surface), never used for any correctness decision.

Source

pub fn capacity(&self) -> usize

The bounded channel’s configured capacity (PoolConfig::write_queue_capacity).

Trait Implementations§

Source§

impl Clone for WriterTaskHandle

Source§

fn clone(&self) -> WriterTaskHandle

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 Debug for WriterTaskHandle

Source§

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

Formats the value using the given formatter. Read more

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> 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more