Skip to main content

QueueEvent

kithara_queue

Enum QueueEvent 

Source 
pub enum QueueEvent {

Show 13 variants    TrackAdded {
        id: TrackId,
        index: usize,
    },
    TrackRemoved {
        id: TrackId,
    },
    TrackStatusChanged {
        id: TrackId,
        status: TrackStatus,
    },
    CurrentTrackChanged {
        id: Option<TrackId>,
    },
    CurrentTrackAdvance {
        id: Option<TrackId>,
        reason: AdvanceReason,
    },
    QueueEnded,
    TrackLoadFailed {
        id: TrackId,
        reason: String,
        auto_skipped: bool,
    },
    CrossfadeSettingsChanged {
        settings: CrossfadeSettings,
    },
    PlaybackOrderChanged {
        order: PlaybackOrder,
    },
    ActionAtItemEndChanged {
        action: ActionAtItemEnd,
    },
    RepeatModeChanged {
        mode: QueueRepeatMode,
    },
    NextTrackReady {
        id: TrackId,
        index: usize,
    },
    CrossfadeStarted {
        settings: CrossfadeSettings,
    },

}
Expand description

Queue-level events emitted by kithara-queue::Queue.

Variants§

§

TrackAdded

A new track was appended / inserted at index.

Fields

§id: TrackId
§index: usize
§

TrackRemoved

A track was removed from the queue.

Fields

§id: TrackId
§

TrackStatusChanged

A track’s loading status changed.

Fields

§id: TrackId
§status: TrackStatus
§

CurrentTrackChanged

The currently playing track changed.

Fields

§id: Option<TrackId>
§

CurrentTrackAdvance

Why the current track advanced.

Fields

§id: Option<TrackId>
§reason: AdvanceReason
§

QueueEnded

Queue reached the end and is not repeating.

§

TrackLoadFailed

The current track failed to load or continue, and the queue may have skipped it.

Fields

§id: TrackId
§reason: String
§auto_skipped: bool
§

CrossfadeSettingsChanged

Fields

§settings: CrossfadeSettings
§

PlaybackOrderChanged

Fields

§order: PlaybackOrder
§

ActionAtItemEndChanged

Fields

§action: ActionAtItemEnd
§

RepeatModeChanged

Repeat mode changed.

Fields

§mode: QueueRepeatMode
§

NextTrackReady

A successor finished loading and is ready for navigation / handover.

Fields

§id: TrackId
§index: usize
§

CrossfadeStarted

A crossfade between tracks just started. Emitted when Queue::select triggers the engine to fade from a currently-playing track to the newly selected one. UIs can inspect the exact profile captured for this transition.

Fields

§settings: CrossfadeSettings

Trait Implementations§

Source§

impl Clone for QueueEvent

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueueEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Event for QueueEvent

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<E> EventSet for E
where E: Event,

Source§

type Receivers = TopicReceiver<E>

Source§

fn publish(bus: &EventBus, meta: EventMeta, event: E)

Source§

fn recv( rx: &mut <E as EventSet>::Receivers, ) -> impl Future<Output = Result<Envelope<E>, RecvError>> + Send

Source§

fn subscribe(bus: &EventBus) -> <E as EventSet>::Receivers

Source§

fn try_recv( rx: &mut <E as EventSet>::Receivers, ) -> Result<Envelope<E>, TryRecvError>

Errors Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> HangDump for T

Source§

fn dump_json(&self) -> String

Source§

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

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more