Struct QueueEntry 

pub struct QueueEntry { /* private fields */ }

Denotes one source in the in-memory manager collection.

Implementations

impl QueueEntry

pub const fn id(&self) -> QueueId

Observes stable queue identity.

pub fn source(&self) -> &str

Observes the requested source.

pub fn output(&self) -> Option<&Path>

Observes the explicit output path when present.

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

Observes the extracted media title when known.

pub const fn transfer(&self) -> &TransferState

Observes transfer state.

pub const fn options(&self) -> &DownloadOptions

Observes choices fixed when execution first starts.

pub const fn formats(&self) -> &FormatCatalog

Observes discovered selectable formats.

pub fn is_editable(&self) -> bool

Observes whether request choices remain editable.

pub fn detail_controls(&self) -> Vec<DetailControl>

Derives visible details controls from transfer state.

pub fn space_action(&self) -> Option<SpaceAction>

Derives the currently valid meaning of Space.

pub fn transfer_command(&self) -> Option<SyncCommand>

States exactly the command an interpreter would run to perform this request.

Only a transfer is performed by naming a program. The command is derived from the two ends, the way of transferring, and the rehearsal mode, so changing any of them changes it. An interpreter runs this command, and a reader reads this command: one derivation, so what is shown and what is run cannot drift apart.

pub fn stated_command(&self) -> Option<String>

States what an interpreter would run, as a reader reads it.

pub fn log(&self) -> impl DoubleEndedIterator<Item = &str>

Observes the notes stated about this request, in the order they were stated.

pub fn label(&self) -> &str

Derives the source input before inspection and the media title afterward.

Trait Implementations

impl Clone for QueueEntry

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueueEntry

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

Formats the value using the given formatter.

impl FormatChoiceViewAlg for QueueEntry

type Format = Format

Represents one described selectable format.

fn discovery(&self) -> DiscoveryState<'_>

Observes what discovery has stated about this request’s formats.

fn described_formats(&self) -> impl Iterator<Item = &Self::Format>

Observes the described formats in extractor preference order.

impl PartialEq for QueueEntry

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl QueueEntryAlg for QueueEntry

fn label(&self) -> &str

Observes the submitted source until extraction supplies a title, and that title after.

fn source(&self) -> &str

Observes the source the request was submitted with.

fn phase(&self) -> TransferPhase

Observes the lifecycle phase the request has reached.

fn dry_run(&self) -> Option<bool>

Observes the rehearsal mode, and that the request has none when it has none.

fn output_naming(&self) -> OutputNaming

Observes how the output is named, which decides what an edited name is taken to be.

fn stated_command(&self) -> Option<String>

Observes exactly what an interpreter would run to perform the request.

fn output(&self) -> Option<&Path>

Observes the explicit output path when present.

fn is_editable(&self) -> bool

Observes whether request choices remain editable.

fn detail_controls(&self) -> Vec<DetailControl>

Derives visible details controls from transfer state.

fn download_log(&self) -> impl Iterator<Item = &str>

Observes the notes stated about this request, in the order they were stated.

fn space_action(&self) -> Option<SpaceAction>

Derives the currently valid meaning of Space.

impl RehearsalViewAlg for QueueEntry

type Change = PlannedChange

Represents one change a rehearsal states.

fn rehearsal(&self) -> RehearsalState<'_>

Observes what rehearsal has stated about this request.

fn planned_changes(&self) -> impl Iterator<Item = &Self::Change>

Observes the changes a rehearsal stated, in the order it stated them.

impl RequestOptionsAlg for QueueEntry

fn performer(&self) -> Performer

Observes what performs the request.

fn media_streams(&self) -> Option<MediaStreams>

Observes the stream roles the request prefers, and that it chooses no media when it transfers something a media role says nothing about.

fn chosen_choice(&self) -> Option<&str>

Observes the one choice the request fixes, when it fixes one.

fn selectable_choices(&self) -> impl Iterator<Item = &str>

Observes every choice the request offers, in the order it offers them.

fn choice_summary(&self, choice: &str) -> Option<&str>

Observes what one offered choice states about itself, when it states anything.

impl StructuralPartialEq for QueueEntry

impl TransferViewAlg for QueueEntry

fn transferred(&self) -> u64

Observes retrieved bytes.

fn transfer_total(&self) -> Option<u64>

Observes expected bytes when the source states them.

fn transfer_elapsed(&self) -> Duration

Observes elapsed transfer time.

fn transfer_complete(&self) -> bool

Observes whether the transfer reached terminal success.

fn transfer_destination(&self) -> Option<&Path>

Observes the path publication will produce once an interpreter states one.

fn transfer_summary(&self) -> Option<&str>

Observes the concise reason a transfer failed.

fn transfer_detail(&self) -> Option<&str>

Observes the diagnostic accompanying a failure.