[−][src]Struct futures_codec::FramedWrite
A Sink
of frames encoded to an AsyncWrite
.
Example
use bytes::Bytes; use futures_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
impl<T, E> FramedWrite<T, E> where
T: AsyncWrite,
E: Encoder,
[src]
T: AsyncWrite,
E: Encoder,
pub fn new(inner: T, encoder: E) -> Self
[src]
Creates a new FramedWrite
transport with the given Encoder
.
pub fn send_high_water_mark(&self) -> usize
[src]
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.
pub fn set_send_high_water_mark(&mut self, hwm: usize)
[src]
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.
pub fn release(self) -> (T, E)
[src]
Release the I/O and Encoder
pub fn into_inner(self) -> T
[src]
Consumes the FramedWrite
, returning its underlying I/O stream.
Note that care should be taken to not tamper with the underlying stream of data coming in as it may corrupt the stream of frames otherwise being worked with.
pub fn encoder(&self) -> &E
[src]
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.
pub fn encoder_mut(&mut self) -> &mut E
[src]
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
impl<T: Debug, E: Debug> Debug for FramedWrite<T, E>
[src]
impl<T, E> Deref for FramedWrite<T, E>
[src]
impl<T, E> DerefMut for FramedWrite<T, E>
[src]
impl<T, E> PinnedDrop for FramedWrite<T, E>
[src]
impl<T, E> Sink<<E as Encoder>::Item> for FramedWrite<T, E> where
T: AsyncWrite + Unpin,
E: Encoder,
[src]
T: AsyncWrite + Unpin,
E: Encoder,
type Error = E::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>>
[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
fn start_send(self: Pin<&mut Self>, item: E::Item) -> Result<(), Self::Error>
[src]
fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
impl<'pin, T, E> Unpin for FramedWrite<T, E> where
__FramedWrite<'pin, T, E>: Unpin,
[src]
__FramedWrite<'pin, T, E>: Unpin,
impl<T, E> UnsafeUnpin for FramedWrite<T, E>
[src]
Auto Trait Implementations
impl<T, E> RefUnwindSafe for FramedWrite<T, E> where
E: RefUnwindSafe,
T: RefUnwindSafe,
E: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, E> Send for FramedWrite<T, E> where
E: Send,
T: Send,
E: Send,
T: Send,
impl<T, E> Sync for FramedWrite<T, E> where
E: Sync,
T: Sync,
E: Sync,
T: Sync,
impl<T, E> UnwindSafe for FramedWrite<T, E> where
E: UnwindSafe,
T: UnwindSafe,
E: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]
T: Sink<Item> + ?Sized,
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
[src]
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
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>>,
[src]
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]
F: FnOnce(Self::Error) -> E,
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
[src]
Self::Error: Into<E>,
fn buffer(self, capacity: usize) -> Buffer<Self, Item>
[src]
fn close(&mut self) -> Close<Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
fn flush(&mut self) -> Flush<Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
fn send(&mut self, item: Item) -> Send<Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
[src]
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>,
[src]
Si2: Sink<Item, Error = Self::Error>,
fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>,
[src]
Si1: Sink<Item, Error = Self::Error>,
fn poll_ready_unpin(
&mut self,
cx: &mut Context
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]
Self: Unpin,
fn poll_flush_unpin(
&mut self,
cx: &mut Context
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
fn poll_close_unpin(
&mut self,
cx: &mut Context
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,