Struct Command 

pub struct Command {
    pub name: String,
    pub transaction_id: f64,
    pub arguments: Vec<Amf0Value>,
}

An RTMP Command Message body (§7.1.1): name (AMF0 String) + AMF0 transaction_id (AMF0 Number) + zero or more argument values (typically a Command Object, then optional trailing arguments) — see docs/rtmp.md §8.2’s closing note and §6.1 (Command Message).

This is the message-body-level container: unlike Amf0Value it is not itself a single AMF0 value-type, so it uses inherent parse/to_body methods rather than the Parse/Serialize traits.

Fields

name: String

The command name, e.g. "connect", "createStream", "publish", "_result".

transaction_id: f64

The transaction id correlating a response to its request (0 for commands that expect no response, e.g. onStatus).

arguments: Vec<Amf0Value>

The remaining AMF0 values in the command body, in wire order (conventionally: Command Object, then any further arguments).

Implementations

impl Command

pub fn parse(payload: &[u8]) -> Result<Self, RtmpError>

Parse a Command Message body: AMF0 String (name) + AMF0 Number (transaction_id) + the remaining AMF0 values (arguments), read until payload is exhausted.

Errors

RtmpError::Malformed if the first value is not a String or the second is not a Number; RtmpError::BufferTooShort / RtmpError::Unsupported propagated from Amf0Value::parse.

pub fn to_body(&self) -> Vec<u8>

Serialize this command back to an AMF0 command payload: name + transaction_id + arguments, in that order.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Command

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Command

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Command