Struct Publish

pub struct Publish { /* private fields */ }

The command to tell publishing information.

Implementations

impl Publish

pub fn new(publishing_name: AmfString, publishing_type: AmfString) -> Self

Constructs a Publish command.

pub fn get_publishing_name(&self) -> &AmfString

Gets the publishing identifier. (e.g. filename, username, etc.)

pub fn get_publishing_type(&self) -> &AmfString

Gets one of publishing type which is either "live", "record" or "append".

Trait Implementations

impl ChunkData for Publish

const CHANNEL: Channel = Channel::Source

const MESSAGE_TYPE: MessageType = MessageType::Command

impl Clone for Publish

fn clone(&self) -> Publish

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Publish

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

Formats the value using the given formatter.

impl Decoder<Publish> for ByteBuffer

fn decode(&mut self) -> IOResult<Publish>

Decodes bytes into a Publish command.

Errors

• InsufficientBufferLength

When some field misses.

• InconsistentMarker

When some value is inconsistent with its marker.

• InvalidString

When some value is invalid for UTF-8 string.

• InvalidPublishingType

When the publishing type is neither "live", "record" nor "append".

Examples

use sheave_core::{
    ByteBuffer,
    Decoder,
    Encoder,
    messages::{
        Publish,
        amf::v0::{
            AmfString,
            Null
        }
    }
};

let mut buffer = ByteBuffer::default();
buffer.encode(&Null);
buffer.encode(&AmfString::default());
buffer.encode(&AmfString::from("live"));
assert!(Decoder::<Publish>::decode(&mut buffer).is_ok());

let mut buffer = ByteBuffer::default();
buffer.encode(&Null);
buffer.encode(&AmfString::default());
buffer.encode(&AmfString::from("record"));
assert!(Decoder::<Publish>::decode(&mut buffer).is_ok());

let mut buffer = ByteBuffer::default();
buffer.encode(&Null);
buffer.encode(&AmfString::default());
buffer.encode(&AmfString::from("append"));
assert!(Decoder::<Publish>::decode(&mut buffer).is_ok());

let mut buffer = ByteBuffer::default();
buffer.encode(&Null);
buffer.encode(&AmfString::default());
buffer.encode(&AmfString::from("something else"));
assert!(Decoder::<Publish>::decode(&mut buffer).is_err())

impl Encoder<Publish> for ByteBuffer

fn encode(&mut self, publish: &Publish)

Encodes a Publish command into bytes.

impl From<Publish> for (AmfString, AmfString)

fn from(publish: Publish) -> Self

Converts to this type from the input type.

impl PartialEq for Publish

fn eq(&self, other: &Publish) -> 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 Command for Publish

impl StructuralPartialEq for Publish