Struct bonsaidb::server::fabruic::Sender

pub struct Sender<T>where
    T: Serialize,{ /* private fields */ }

Used to send data to a stream.

Implementations

impl<T> Sender<T>where T: Serialize,

pub fn send(&self, data: &T) -> Result<(), Sender>

Send data into the stream.

Errors

• error::Sender::Serialize if data failed to be serialized
• error::Sender::Write if the Sender failed to to write to the stream
• error::Sender::Closed if the Sender is closed

pub async fn finish(&self) -> impl Future<Output = Result<(), Sender>>

Shut down the Send part of the stream gracefully.

No new data may be written after calling this method. Completes when the peer has acknowledged all sent data, retransmitting data as needed.

Errors

This can only return error::Sender::Closed as an Err, if it was already closed, but if the Sender failed to write to the stream it will return a queued error::Sender::Write.

pub async fn close(&self) -> impl Future<Output = Result<(), Sender>>

Close the Sender immediately.

To close a Sender gracefully use Sender::finish.

Errors

This can only return error::Sender::Closed as an Err, if it was already closed, but if the Sender failed to write to the stream it will return a queued error::Sender::Write.

Trait Implementations

impl<T> Clone for Sender<T>where T: Clone + Serialize,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Sender<T>where T: Debug + Serialize,

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

Formats the value using the given formatter.