Struct dencode::FramedWrite [−][src]
pub struct FramedWrite<T, E> { /* fields omitted */ }
Expand description
A Sink
of frames encoded to an AsyncWrite
.
Example
use bytes::Bytes; use dencode::{BytesCodec, FramedWrite}; 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>
[src]
impl<T, E> FramedWrite<T, E>
[src]pub fn new(inner: T, encoder: E) -> Self
[src]
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]
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]
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 into_inner(self) -> T
[src]
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]
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]
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: Debug, E: Debug> Debug for FramedWrite<T, E>
[src]impl<T, E> Deref 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> DerefMut for FramedWrite<T, E>
[src]impl<T, E, I> IterSink<I> for FramedWrite<T, E> where
T: Write,
E: Encoder<I>,
[src]
impl<T, E, I> IterSink<I> for FramedWrite<T, E> where
T: Write,
E: Encoder<I>,
[src]fn start_send(&mut self, item: I) -> Result<(), Self::Error>
[src]
fn start_send(&mut self, item: I) -> Result<(), Self::Error>
[src]Write a value to the internal buffer.
Each call to this function must be preceded by a successful call to ready
. Read more
impl<T, E, I> Sink<I> for FramedWrite<T, E> where
T: AsyncWrite + Unpin,
E: Encoder<I>,
[src]
impl<T, E, I> Sink<I> for FramedWrite<T, E> where
T: AsyncWrite + Unpin,
E: Encoder<I>,
[src]fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]
fn poll_ready(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>
[src]Attempts to prepare the Sink
to receive a value. Read more
fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>
[src]
fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), Self::Error>
[src]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
impl<'pin, T, E> Unpin for FramedWrite<T, E> where
__FramedWrite<'pin, T, E>: Unpin,
[src]
__FramedWrite<'pin, T, E>: Unpin,
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> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::Error>,
Fut: Future<Output = Result<Item, E>>,
F: FnMut(U) -> Fut,
[src]
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::Error>,
Fut: Future<Output = Result<Item, E>>,
F: FnMut(U) -> Fut,
[src]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>>,
[src]
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]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,
[src]
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]Transforms the error returned by the sink.
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
[src]
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
[src]Map this sink’s error to a different error type using the Into
trait. Read more
fn buffer(self, capacity: usize) -> Buffer<Self, Item>
[src]
fn buffer(self, capacity: usize) -> Buffer<Self, Item>
[src]Adds a fixed-size buffer to the current sink. Read more
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
[src]Fanout items to multiple sinks. Read more
fn flush(&mut self) -> Flush<'_, Self, Item> where
Self: Unpin,
[src]
fn flush(&mut self) -> Flush<'_, Self, Item> where
Self: Unpin,
[src]Flush the sink, processing all pending items. Read more
fn send(&mut self, item: Item) -> Send<'_, Self, Item> where
Self: Unpin,
[src]
fn send(&mut self, item: Item) -> Send<'_, Self, Item> where
Self: Unpin,
[src]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,
[src]
fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where
Self: Unpin,
[src]A future that completes after the given item has been received by the sink. Read more
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]
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]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>,
[src]
fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>,
[src]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>,
[src]
fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>,
[src]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,
[src]
fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]A convenience method for calling Sink::poll_ready
on Unpin
sink types. Read more
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]
fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]A convenience method for calling Sink::start_send
on Unpin
sink types. Read more