Skip to main content

EncoderWorker

Struct EncoderWorker 

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

A persistent worker thread that executes submitted closures sequentially (in submission order). Designed for command-buffer encoding workloads where the cost of std::thread::spawn per task would dwarf the work.

The worker is single-threaded; submissions execute one-at-a-time. For parallelism with the main thread, the typical pattern is:

  1. Spawn one EncoderWorker at process start.
  2. Per token: submit half the encoding work to the worker, encode the other half on the main thread, wait for both to complete.

EncoderWorker is NOT a thread pool — for that, spawn multiple workers.

Implementations§

Source§

impl EncoderWorker

Source

pub fn spawn() -> Self

Spawn a new persistent worker thread. The thread runs until either Self::shutdown is called or the EncoderWorker is dropped.

The worker’s run-loop blocks on the channel; CPU usage is zero when idle.

Source

pub fn submit<F>(&self, f: F) -> Result<(), &'static str>
where F: FnOnce() + Send + 'static,

Submit a closure for execution on the worker thread. Returns immediately; the closure runs asynchronously.

To wait for the closure to complete, the caller must arrange its own signaling (e.g., a (tx, rx) channel pair captured by the closure).

§Errors

Returns Err if the worker thread has been shut down or has panicked.

Source

pub fn shutdown(&mut self)

Cleanly shut down the worker. Drops the sender (closing the channel), then joins the worker thread. Returns once the worker has processed all in-flight tasks.

Trait Implementations§

Source§

impl Drop for EncoderWorker

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