Struct Sender

Source
pub struct Sender<Tx: WireTx> { /* private fields */ }
Expand description

The Sender type wraps a WireTx impl, and provides higher level functionality over it

Implementations§

Source§

impl<Tx: WireTx> Sender<Tx>

Source

pub fn new(tx: Tx, kkind: VarKeyKind) -> Self

Create a new Sender

Takes a WireTx impl, as well as the VarKeyKind used when sending messages to the client.

kkind should usually come from Dispatch::min_key_len().

Source

pub async fn reply<E>( &self, seq_no: VarSeq, resp: &E::Response, ) -> Result<(), Tx::Error>

Send a reply for the given endpoint

Source

pub async fn reply_keyed<T>( &self, seq_no: VarSeq, key: Key, resp: &T, ) -> Result<(), Tx::Error>
where T: ?Sized + Serialize + Schema,

Send a reply with the given Key

This is useful when replying with “unusual” keys, for example Error responses not tied to any specific Endpoint.

Source

pub async fn publish<T>( &self, seq_no: VarSeq, msg: &T::Message, ) -> Result<(), Tx::Error>
where T: ?Sized + Topic, T::Message: Serialize + Schema,

Publish a Topic message

Source

pub async fn log_str(&self, msg: &str) -> Result<(), Tx::Error>

Log a str directly to the LoggingTopic

Source

pub async fn log_fmt(&self, msg: Arguments<'_>) -> Result<(), Tx::Error>

Format a message to the LoggingTopic

Source

pub async fn error( &self, seq_no: VarSeq, error: WireError, ) -> Result<(), Tx::Error>

Send a single error message

Source

pub async fn send_all_schemas( &self, hdr: &VarHeader, device_map: &DeviceMap, ) -> Result<(), Tx::Error>

Implements the GetAllSchemasEndpoint endpoint

Trait Implementations§

Source§

impl<Tx: Clone + WireTx> Clone for Sender<Tx>

Source§

fn clone(&self) -> Sender<Tx>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<Tx> Freeze for Sender<Tx>
where Tx: Freeze,

§

impl<Tx> RefUnwindSafe for Sender<Tx>
where Tx: RefUnwindSafe,

§

impl<Tx> Send for Sender<Tx>
where Tx: Send,

§

impl<Tx> Sync for Sender<Tx>
where Tx: Sync,

§

impl<Tx> Unpin for Sender<Tx>
where Tx: Unpin,

§

impl<Tx> UnwindSafe for Sender<Tx>
where Tx: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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