Struct asynchronous_codec::FramedWrite

source ·
pub struct FramedWrite<T, E> { /* private fields */ }
Expand description

A Sink of frames encoded to an AsyncWrite.

§Example

use bytes::Bytes;
use asynchronous_codec::{FramedWrite, BytesCodec};
use futures::SinkExt;

let mut buf = Vec::new();
let mut framed = FramedWrite::new(&mut buf, BytesCodec {});

let bytes = Bytes::from("Hello World!");
framed.send(bytes.clone()).await?;

assert_eq!(&buf[..], &bytes[..]);

Implementations§

source§

impl<T, E> FramedWrite<T, E>
where T: AsyncWrite, E: Encoder,

source

pub fn new(inner: T, encoder: E) -> Self

Creates a new FramedWrite transport with the given Encoder.

source

pub fn from_parts(_: FramedWriteParts<T, E>) -> Self

Creates a new FramedWrite from FramedWriteParts.

See also FramedWrite::into_parts.

source

pub fn send_high_water_mark(&self) -> usize

High-water mark for writes, in bytes

The send high-water mark prevents the FramedWrite from accepting additional messages to send when its buffer exceeds this length, in bytes. Attempts to enqueue additional messages will be deferred until progress is made on the underlying AsyncWrite. This applies back-pressure on fast senders and prevents unbounded buffer growth.

See set_send_high_water_mark().

source

pub fn set_send_high_water_mark(&mut self, hwm: usize)

Sets high-water mark for writes, in bytes

The send high-water mark prevents the FramedWrite from accepting additional messages to send when its buffer exceeds this length, in bytes. Attempts to enqueue additional messages will be deferred until progress is made on the underlying AsyncWrite. This applies back-pressure on fast senders and prevents unbounded buffer growth.

The default high-water mark is 2^17 bytes. Applications which desire low latency may wish to reduce this value. There is little point to increasing this value beyond your socket’s SO_SNDBUF size. On linux, this defaults to 212992 bytes but is user-adjustable.

source

pub fn into_parts(self) -> FramedWriteParts<T, E>

Consumes the FramedWrite, returning its parts such that a new FramedWrite may be constructed, possibly with a different encoder.

See also FramedWrite::from_parts.

source

pub fn into_inner(self) -> T

Consumes the FramedWrite, returning its underlying I/O stream.

Note that data that has already been written but not yet flushed is dropped. To retain any such potentially buffered data, use FramedWrite::into_parts().

source

pub fn encoder(&self) -> &E

Returns a reference to the underlying encoder.

Note that care should be taken to not tamper with the underlying encoder as it may corrupt the stream of frames otherwise being worked with.

source

pub fn encoder_mut(&mut self) -> &mut E

Returns a mutable reference to the underlying encoder.

Note that care should be taken to not tamper with the underlying encoder as it may corrupt the stream of frames otherwise being worked with.

Trait Implementations§

source§

impl<T: Debug, E: Debug> Debug for FramedWrite<T, E>

source§

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

Formats the value using the given formatter. Read more
source§

impl<T, E> Deref for FramedWrite<T, E>

§

type Target = T

The resulting type after dereferencing.
source§

fn deref(&self) -> &T

Dereferences the value.
source§

impl<T, E> DerefMut for FramedWrite<T, E>

source§

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

Mutably dereferences the value.
source§

impl<T, E> Sink<<E as Encoder>::Item> for FramedWrite<T, E>
where T: AsyncWrite + Unpin, E: Encoder,

§

type Error = <E as Encoder>::Error

The type of value produced by the sink when an error occurs.
source§

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

fn start_send(self: Pin<&mut Self>, item: E::Item) -> 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
source§

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

Flush any remaining output from this sink. Read more
source§

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

impl<'__pin, T, E> Unpin for FramedWrite<T, E>
where __Origin<'__pin, T, E>: Unpin,

Auto Trait Implementations§

§

impl<T, E> Freeze for FramedWrite<T, E>
where T: Freeze, E: Freeze,

§

impl<T, E> RefUnwindSafe for FramedWrite<T, E>

§

impl<T, E> Send for FramedWrite<T, E>
where T: Send, E: Send,

§

impl<T, E> Sync for FramedWrite<T, E>
where T: Sync, E: Sync,

§

impl<T, E> UnwindSafe for FramedWrite<T, E>
where T: UnwindSafe, E: 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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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, Item> SinkExt<Item> for T
where T: Sink<Item> + ?Sized,

source§

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

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

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.
source§

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

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

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

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

Close the sink.
source§

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

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

Flush the sink, processing all pending items. Read more
source§

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

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

fn send_all<'a, St>(&'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
source§

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

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

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.
source§

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.
source§

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.
source§

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.
source§

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

§

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>,

§

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.