Enum selium_protocol::Frame

pub enum Frame {
    RegisterPublisher(PublisherPayload),
    RegisterSubscriber(SubscriberPayload),
    RegisterReplier(ReplierPayload),
    RegisterRequestor(RequestorPayload),
    Message(MessagePayload),
    BatchMessage(Bytes),
    Error(Bytes),
    Ok,
}

Variants

RegisterPublisher(PublisherPayload)

RegisterSubscriber(SubscriberPayload)

RegisterReplier(ReplierPayload)

RegisterRequestor(RequestorPayload)

Message(MessagePayload)

BatchMessage(Bytes)

Error(Bytes)

Ok

Implementations

impl Frame

pub fn get_length(&self) -> Result<u64>

pub fn get_type(&self) -> u8

pub fn get_topic(&self) -> Option<&TopicName>

pub fn write_to_bytes(self, dst: &mut BytesMut) -> Result<()>

pub fn unwrap_message(self) -> MessagePayload

Trait Implementations

impl Clone for Frame

fn clone(&self) -> Frame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Frame

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

Formats the value using the given formatter.

impl Encoder<Frame> for MessageCodec

type Error = SeliumError

The type of encoding errors.

fn encode(&mut self, item: Frame, dst: &mut BytesMut) -> Result<(), Self::Error>

Encodes a frame into the buffer provided.

impl PartialEq for Frame

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Sink<Frame> for BiStream

type Error = SeliumError

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Frame) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl Sink<Frame> for WriteHalf

type Error = SeliumError

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Frame) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl TryFrom<(u8, BytesMut)> for Frame

type Error = SeliumError

The type returned in the event of a conversion error.

fn try_from( (message_type, bytes): (u8, BytesMut) ) -> Result<Self, <Frame as TryFrom<(u8, BytesMut)>>::Error>

Performs the conversion.

impl StructuralPartialEq for Frame