Message

epicars::messages

Enum Message

pub enum Message {
Show 23 variants
    AccessRights(AccessRights),
    ClearChannel(ClearChannel),
    ClientName(ClientName),
    CreateChannel(CreateChannel),
    CreateChannelFailure(CreateChannelFailure),
    CreateChannelResponse(CreateChannelResponse),
    ECAError(ECAError),
    Echo,
    EventAdd(EventAdd),
    EventCancel(EventCancel),
    EventAddResponse(EventAddResponse),
    EventsOff,
    EventsOn,
    HostName(HostName),
    ReadNotify(ReadNotify),
    ReadNotifyResponse(ReadNotifyResponse),
    RsrvIsUp(RsrvIsUp),
    Search(Search),
    SearchResponse(SearchResponse),
    ServerDisconnect(ServerDisconnect),
    Write(Write),
    WriteNotify(WriteNotify),
    Version(Version),
}

Expand description

Represent any message.

Provides utility function Message::read_server_message to translate a raw stream into parsed messages.

Variants§

AccessRights(AccessRights)

ClearChannel(ClearChannel)

ClientName(ClientName)

CreateChannel(CreateChannel)

CreateChannelFailure(CreateChannelFailure)

CreateChannelResponse(CreateChannelResponse)

ECAError(ECAError)

Echo

EventAdd(EventAdd)

EventCancel(EventCancel)

EventAddResponse(EventAddResponse)

EventsOff

EventsOn

HostName(HostName)

ReadNotify(ReadNotify)

ReadNotifyResponse(ReadNotifyResponse)

RsrvIsUp(RsrvIsUp)

Search(Search)

SearchResponse(SearchResponse)

ServerDisconnect(ServerDisconnect)

Write(Write)

WriteNotify(WriteNotify)

Version(Version)

Implementations§

impl Message

pub async fn read_server_message<T: AsyncRead + Unpin>( source: &mut T, ) -> Result<Self, MessageError>

Parse message sent to the server, directly from a stream.

Handles any message that could be sent to the server, not messages that could be sent to a client. This is because some response messages have the same command ID but different fields, so it is impossible to tell which is which purely from the contents of the message.

Trait Implementations§

impl AsBytes for Message

fn as_bytes(&self) -> Vec<u8> ⓘ

impl Debug for Message

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for Message

impl RefUnwindSafe for Message

impl Send for Message

impl Sync for Message

impl Unpin for Message

impl UnwindSafe for Message

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more