Trait WireTx

pub trait WireTx {
    type Error: AsWireTxErrorKind;

    // Required methods
    async fn send<T: Serialize + ?Sized>(
        &self,
        hdr: VarHeader,
        msg: &T,
    ) -> Result<(), Self::Error>;
    async fn send_raw(&self, buf: &[u8]) -> Result<(), Self::Error>;
    async fn send_log_str(
        &self,
        kkind: VarKeyKind,
        s: &str,
    ) -> Result<(), Self::Error>;
    async fn send_log_fmt<'a>(
        &self,
        kkind: VarKeyKind,
        a: Arguments<'a>,
    ) -> Result<(), Self::Error>;
}

This trait defines how the server sends frames to the client

Required Associated Types

type Error: AsWireTxErrorKind

The error type of this connection.

For simple cases, you can use WireTxErrorKind directly. You can also use your own custom type that implements AsWireTxErrorKind.

Required Methods

async fn send<T: Serialize + ?Sized>( &self, hdr: VarHeader, msg: &T, ) -> Result<(), Self::Error>

Send a single frame to the client, returning when send is complete.

async fn send_raw(&self, buf: &[u8]) -> Result<(), Self::Error>

Send a single frame to the client, without handling serialization

async fn send_log_str( &self, kkind: VarKeyKind, s: &str, ) -> Result<(), Self::Error>

Send a logging message on the LoggingTopic

This message is simpler as it does not do any formatting

async fn send_log_fmt<'a>( &self, kkind: VarKeyKind, a: Arguments<'a>, ) -> Result<(), Self::Error>

Send a logging message on the LoggingTopic

This version formats to the outgoing buffer

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl WireTx for ChannelWireTx

type Error = ChannelWireTxError

impl<M: RawMutex + 'static, D: Driver<'static> + 'static> WireTx for EUsbWireTx<M, D>

type Error = WireTxErrorKind