Struct pikadick::util::encoder_task::EncoderTask

pub struct EncoderTask {
    handle: Arc<Mutex<Option<JoinHandle<()>>>>,
    tx: Sender<Message>,
}

A task to re-encode things

Fields

handle: Arc<Mutex<Option<JoinHandle<()>>>>

tx: Sender<Message>

Implementations

impl EncoderTask

pub fn new() -> Self

Make a new encoder task

pub async fn get_encoders(&self, validate: bool) -> Result<Vec<Encoder>>

Get encoders

pub fn encode(&self) -> EncoderTaskEncodeBuilder<'_>

Create a builder for an encode request

pub async fn close(&self) -> Result<()>

Request this task to close

pub async fn join(&self) -> Result<()>

Join this task, waiting for it to exit.

This will NOT send a shutdown request, that must be done beforehand. Also, this function can only be called once. Future calls will return an error.

pub async fn shutdown(&self) -> Result<()>

Shutdown the task, sending a close request can joining the task.

This calls join under the hood, so it has the same restrictions as close: Either shutdown or close can only be called once.

Trait Implementations

impl Clone for EncoderTask

fn clone(&self) -> EncoderTask

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EncoderTask

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

Formats the value using the given formatter.

impl Default for EncoderTask

fn default() -> Self

Returns the “default value” for a type.