Struct QueueItem 

pub struct QueueItem { /* private fields */ }

An item in a download queue.

Implementations

impl QueueItem

pub fn id(&self) -> u32

pub fn queue(&self) -> DownloadQueue

pub fn key(&self) -> &str

pub fn status(&self) -> QueueItemStatus

pub fn stats(&self) -> Option<TranscodeSessionStats>

If this item is currently being transcoded this will return the current transcode stats.

pub fn error(&self) -> Option<&str>

If the status is an error this may reveal more information.

pub fn is_transcode(&self) -> bool

Returns true if this item was or is being transcoded. If false then downloading will just download the original media file.

pub async fn container(&self) -> Result<ContainerFormat>

Returns the container format of the file that will be downloaded.

This will fail if the item is not available.

pub async fn content_length(&self) -> Result<Option<u64>>

Returns the expected length of the download.

This will fail if the item is not available.

pub async fn update(&mut self) -> Result<()>

Updates the state of this item by re-fetching it from the server.

pub async fn download<W, R>(&self, writer: W, range: R) -> Result

where W: AsyncWrite + Unpin, R: RangeBounds<u64>,

Downloads the item to the provided writer.

This will fail if the item is not available.

pub async fn delete(self) -> Result<()>

Deletes this item from the download queue.

Trait Implementations

impl Debug for QueueItem

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

Formats the value using the given formatter.