Struct tokio_util::codec::FramedWrite [−][src]
pub struct FramedWrite<T, E> { /* fields omitted */ }
A Sink
of frames encoded to an AsyncWrite
.
Implementations
impl<T, E> FramedWrite<T, E> where
T: AsyncWrite,
[src]
T: AsyncWrite,
pub fn new(inner: T, encoder: E) -> FramedWrite<T, E>
[src]
Creates a new FramedWrite
with the given encoder
.
impl<T, E> FramedWrite<T, E>
[src]
pub fn get_ref(&self) -> &T
[src]
Returns a reference to the underlying I/O stream wrapped by
FramedWrite
.
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 get_mut(&mut self) -> &mut T
[src]
Returns a mutable reference to the underlying I/O stream wrapped by
FramedWrite
.
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 get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut T>
[src]
Returns a pinned mutable reference to the underlying I/O stream wrapped by
FramedWrite
.
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 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.
pub fn encoder_mut(&mut self) -> &mut E
[src]
Returns a mutable reference to the underlying encoder.
pub fn write_buffer(&self) -> &BytesMut
[src]
Returns a reference to the write buffer.
pub fn write_buffer_mut(&mut self) -> &mut BytesMut
[src]
Returns a mutable reference to the write buffer.
Trait Implementations
impl<T, U> Debug for FramedWrite<T, U> where
T: Debug,
U: Debug,
[src]
T: Debug,
U: Debug,
impl<T, I, E> Sink<I> for FramedWrite<T, E> where
T: AsyncWrite,
E: Encoder<I>,
E::Error: From<Error>,
[src]
T: AsyncWrite,
E: Encoder<I>,
E::Error: From<Error>,
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: I) -> 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<T, D> Stream for FramedWrite<T, D> where
T: Stream,
[src]
T: Stream,
type Item = T::Item
Values yielded by the stream.
fn poll_next(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
[src]
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>
pub fn size_hint(&self) -> (usize, Option<usize>)
[src]
impl<'__pin, T, E> Unpin for FramedWrite<T, E> where
__Origin<'__pin, T, E>: Unpin,
[src]
__Origin<'__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> 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,
pub 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, 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.
pub 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>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<S, T, E> TryStream for S where
S: Stream<Item = Result<T, E>> + ?Sized,
[src]
S: Stream<Item = Result<T, E>> + ?Sized,