Struct StreamBegin

pub struct StreamBegin(/* private fields */);

The event to tell that the stream is ready to a client.

Implementations

impl StreamBegin

pub fn new(message_id: u32) -> Self

Constructs a StreamBegin event.

pub fn get_message_id(&self) -> u32

Gets the message ID which this event has.

Trait Implementations

impl ChunkData for StreamBegin

const CHANNEL: Channel = Channel::Network

const MESSAGE_TYPE: MessageType = MessageType::UserControl

impl Clone for StreamBegin

fn clone(&self) -> StreamBegin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamBegin

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

Formats the value using the given formatter.

impl Decoder<StreamBegin> for ByteBuffer

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

Decodes bytes into a StreamBegin event.

Errors

• InsufficientBufferLength

When some field misses.

Examples

use sheave_core::{
    ByteBuffer,
    Decoder,
    Encoder,
    messages::{
        EventType,
        StreamBegin
    }
};

let mut buffer = ByteBuffer::default();
buffer.put_u32_be(u32::default());
assert!(Decoder::<StreamBegin>::decode(&mut buffer).is_ok());

let mut buffer = ByteBuffer::default();
assert!(Decoder::<StreamBegin>::decode(&mut buffer).is_err())

impl Encoder<StreamBegin> for ByteBuffer

fn encode(&mut self, stream_begin: &StreamBegin)

Encodes a StreamBegin event into bytes.

impl From<StreamBegin> for u32

fn from(stream_begin: StreamBegin) -> Self

Converts to this type from the input type.

impl PartialEq for StreamBegin

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

const EVENT_TYPE: EventType = EventType::StreamBegin

impl Copy for StreamBegin

impl Eq for StreamBegin

impl StructuralPartialEq for StreamBegin