Skip to main content

BackgroundPrefetchWorker

Struct BackgroundPrefetchWorker 

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

One bounded background prefetch worker with exact cancellation and configurable shutdown.

Implementations§

Source§

impl BackgroundPrefetchWorker

Source

pub fn new<F>( capacity: usize, thread_name: impl Into<String>, operation: F, ) -> Result<Self, BackgroundPrefetchWorkerError>
where F: Fn(&OffloadUnitId) -> Result<(), String> + Send + Sync + 'static,

Starts a named worker which executes one backend-owned operation at a time.

Source

pub fn with_nonblocking_drop(self) -> Self

Requests shutdown without joining when this handle is dropped.

The worker retains its operation and lifecycle state until in-flight work returns. Queued work is cancelled by that worker; callers needing a synchronous fence can still explicitly call Self::cancel.

Source

pub fn submit( &self, id: &OffloadUnitId, resident: bool, ) -> Result<(), BackgroundPrefetchWorkerError>

Admits or coalesces one operation after the backend reports current residency.

Source

pub fn wait( &self, id: &OffloadUnitId, ) -> Result<PrefetchDemandResolution<String>, BackgroundPrefetchWorkerError>

Waits for background ownership to resolve and consumes its exact result.

Source

pub fn cancel(&self) -> Result<(), BackgroundPrefetchWorkerError>

Cancels queued work, fences in-flight work, and returns its first failure.

Source

pub fn report( &self, ) -> Result<BackgroundPrefetchReport, BackgroundPrefetchWorkerError>

Returns an immutable lifecycle and backpressure report.

Source

pub fn wait_idle(&self) -> Result<(), BackgroundPrefetchWorkerError>

Waits until all admitted work reaches a terminal state.

Trait Implementations§

Source§

impl Drop for BackgroundPrefetchWorker

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.