Enum UserControl 

#[non_exhaustive]
pub enum UserControl {
    StreamBegin(u32),
    StreamEof(u32),
    StreamDry(u32),
    SetBufferLength {
        stream_id: u32,
        buffer_ms: u32,
    },
    StreamIsRecorded(u32),
    PingRequest(u32),
    PingResponse(u32),
}

A User Control Message event (§5.3, message type id 4; event-data formats per §6.7, spec §7.1.7). SHOULD use message stream id 0 and, over the chunk stream, csid 2. Effective on receipt; timestamps ignored.

#[non_exhaustive]: §6.7’s event-type catalogue (event value 5 is already an unassigned gap) can grow; a new event type must not be a breaking change for existing match callers.

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.

StreamBegin(u32)

Stream Begin (event 0, server→client): the stream is now functional/usable. By default sent on stream id 0 right after a successful connect.

StreamEof(u32)

Stream EOF (event 1, server→client): playback requested on this stream has ended.

StreamDry(u32)

StreamDry (event 2, server→client): no more data on the stream (server-detected idle).

SetBufferLength

SetBufferLength (event 3, client→server): the client’s playback buffer size, sent before the server starts sending the stream.

Fields

stream_id: u32

The stream this buffer length applies to.

buffer_ms: u32

The client’s buffer length, in milliseconds.

StreamIsRecorded(u32)

StreamIsRecorded (event 4, server→client): the stream is a recorded (not live) stream.

PingRequest(u32)

PingRequest (event 6, server→client): test reachability; the client MUST reply with PingResponse.

PingResponse(u32)

PingResponse (event 7, client→server): reply to PingRequest, echoing its timestamp.

Implementations

impl UserControl

pub fn name(&self) -> &'static str

The spec token for this user control event.

pub fn event_type(&self) -> u16

This event’s 16-bit event type value (§6.7).

pub fn to_message(&self) -> Message

Wrap this user control event in a Message ready to hand to crate::chunk::ChunkWriter — chunk stream id CONTROL_CHUNK_STREAM_ID, message stream id CONTROL_MESSAGE_STREAM_ID, timestamp 0 (effective on receipt; timestamps are not meaningful).

Trait Implementations

impl Clone for UserControl

fn clone(&self) -> UserControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for UserControl

impl Debug for UserControl

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

Formats the value using the given formatter.

impl Display for UserControl

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

Formats the value using the given formatter.

impl Eq for UserControl

impl<'a> Parse<'a> for UserControl

type Error = RtmpError

The error type this implementer returns. Typically the enclosing crate’s Error enum.

fn parse(bytes: &'a [u8]) -> Result<Self, RtmpError>

Parse bytes as Self. Returns Err(Self::Error) on any protocol violation or buffer underrun.

impl PartialEq for UserControl

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for UserControl

type Error = RtmpError

The error type this implementer returns (usually the same as the corresponding Parse impl, but need not be).

fn serialized_len(&self) -> usize

Number of bytes serialize_into will write.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize, RtmpError>

Write the serialised form into buf. Returns the number of bytes written (always equal to serialized_len()).

fn to_bytes(&self) -> Vec<u8>

where Self::Error: Debug,

Convenience: allocate a Vec and serialise into it.

impl StructuralPartialEq for UserControl