Struct async_io_typed::AsyncWriteTyped

impl<W: AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> AsyncWriteTyped<W, T>

pub fn new_with_limit(raw: W, size_limit: u64) -> Self

Creates a typed writer, initializing it with the given size limit specified in bytes.

Be careful, large limits might create a vulnerability to a Denial of Service attack.

pub fn new(raw: W) -> Self

Creates a typed writer, initializing it with a default size limit of 1 MB per message.

pub fn inner(&self) -> &W

pub fn into_inner(self) -> W

pub fn optimize_memory_usage(&mut self)

AsyncWriteTyped keeps a memory buffer for sending values which is the same size as the largest message that’s been sent. If the message size varies a lot, you might find yourself wasting memory space. This function will reduce the memory usage as much as is possible without impeding functioning. Overuse of this function may cause excessive memory allocations when the buffer needs to grow.

Trait Implementations§

impl<W: Debug + AsyncWrite + Unpin, T: Debug + Serialize + DeserializeOwned + Unpin> Debug for AsyncWriteTyped<W, T>

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

Formats the value using the given formatter. Read more

impl<W: AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> Drop for AsyncWriteTyped<W, T>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<W: AsyncWrite + Unpin, T: Serialize + DeserializeOwned + Unpin> Sink<T> for AsyncWriteTyped<W, T>

type Error = Error

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. Read more

fn start_send(self: Pin<&mut Self>, item: T) -> 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(())). Read more

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

Flush any remaining output from this sink. Read more

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

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

Auto Trait Implementations§

impl<W, T> RefUnwindSafe for AsyncWriteTyped<W, T>where
T: RefUnwindSafe,
W: RefUnwindSafe,

impl<W, T> UnwindSafe for AsyncWriteTyped<W, T>where
T: UnwindSafe,
W: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · 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.

impl<T, Item> SinkExt<Item> for Twhere
T: Sink<Item> + ?Sized,

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F>where
 F: FnMut(U) -> Fut,
 Fut: Future<Output = Result<Item, E>>,
 E: From<Self::Error>,
 Self: Sized,

Composes a function in front of the sink. Read more

fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F>where
 F: FnMut(U) -> St,
 St: Stream<Item = Result<Item, Self::Error>>,
 Self: Sized,

Composes a function in front of the sink. Read more

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F>where
F: FnOnce(Self::Error) -> E,
Self: Sized,

Transforms the error returned by the sink.

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E>where
Self: Sized,
Self::Error: Into<E>,

Map this sink’s error to a different error type using the Into trait. Read more

fn buffer(self, capacity: usize) -> Buffer<Self, Item>where
Self: Sized,

Adds a fixed-size buffer to the current sink. Read more

fn close(&mut self) -> Close<'_, Self, Item>where
Self: Unpin,

Close the sink.

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si>where
 Self: Sized,
 Item: Clone,
 Si: Sink<Item, Error = Self::Error>,

Fanout items to multiple sinks. Read more

fn flush(&mut self) -> Flush<'_, Self, Item>where
Self: Unpin,

Flush the sink, processing all pending items. Read more

fn send(&mut self, item: Item) -> Send<'_, Self, Item>where
Self: Unpin,

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item>where
Self: Unpin,

A future that completes after the given item has been received by the sink. Read more

fn send_all<St, 'a>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St>where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

fn left_sink<Si2>(self) -> Either<Self, Si2>where
Si2: Sink<Item, Error = Self::Error>,
Self: Sized,

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

fn right_sink<Si1>(self) -> Either<Si1, Self>where
Si1: Sink<Item, Error = Self::Error>,
Self: Sized,

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

fn poll_ready_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling [Sink::poll_ready] on Unpin sink types.

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error>where
Self: Unpin,

A convenience method for calling [Sink::start_send] on Unpin sink types.

fn poll_flush_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling [Sink::poll_flush] on Unpin sink types.

fn poll_close_unpin(
 &mut self,
 cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>where
 Self: Unpin,

A convenience method for calling [Sink::poll_close] on Unpin sink types.

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

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