Enum PlaybackEnd 

#[non_exhaustive]
pub enum PlaybackEnd {
    Completed,
    Stopped,
    Interrupted,
    SessionEnded,
    Refused,
}

How a playback ended.

A caller needs to be able to tell these apart: “the announcement finished”, “the application cut it off”, “the caller pressed a key”, “the call went away underneath it” and “it never played at all” lead to different next steps. Self::completed is the one-bit answer for callers that only need to know whether the clip ran out.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Completed

The whole clip reached the send queue.

Stopped

Playback::stop cut it short.

Interrupted

A keypress from the far end cut it short — it was started Interrupt::OnDigit and the far end pressed a key (RFC 4733). The keypress itself is still delivered to whoever is reading MediaSession::recv_digit; interrupting consumes nothing.

SessionEnded

The session stopped, or the call ended, under a playback still running.

Refused

The playback queue was full (Playback::QUEUE_DEPTH clips already waiting), so nothing was played at all.

Implementations

impl PlaybackEnd

pub fn completed(self) -> bool

Whether the clip ran to its end, as opposed to being cut short by anything.

Trait Implementations

impl Clone for PlaybackEnd

fn clone(&self) -> PlaybackEnd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlaybackEnd

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

Formats the value using the given formatter.

impl PartialEq for PlaybackEnd

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for PlaybackEnd

impl Eq for PlaybackEnd

impl StructuralPartialEq for PlaybackEnd