Struct monoio_codec::FramedRead
source · pub struct FramedRead<IO, Codec> { /* private fields */ }Implementations§
source§impl<IO, Codec> FramedRead<IO, Codec>
impl<IO, Codec> FramedRead<IO, Codec>
pub fn new(io: IO, decoder: Codec) -> Self
pub fn with_capacity(io: IO, codec: Codec, capacity: usize) -> Self
sourcepub fn get_ref(&self) -> &IO
pub fn get_ref(&self) -> &IO
Returns a reference to the underlying I/O stream wrapped by
FramedRead.
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.
sourcepub fn get_mut(&mut self) -> &mut IO
pub fn get_mut(&mut self) -> &mut IO
Returns a mutable reference to the underlying I/O stream wrapped by
FramedRead.
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.
sourcepub fn into_inner(self) -> IO
pub fn into_inner(self) -> IO
Consumes the FramedRead, 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.
sourcepub fn decoder_mut(&mut self) -> &mut Codec
pub fn decoder_mut(&mut self) -> &mut Codec
Returns a mutable reference to the underlying decoder.
sourcepub fn map_decoder<CodecNew, F>(self, map: F) -> FramedRead<IO, CodecNew>where
F: FnOnce(Codec) -> CodecNew,
pub fn map_decoder<CodecNew, F>(self, map: F) -> FramedRead<IO, CodecNew>where F: FnOnce(Codec) -> CodecNew,
Maps the decoder D to C, preserving the read buffer
wrapped by Framed.
sourcepub fn read_buffer(&self) -> &BytesMut
pub fn read_buffer(&self) -> &BytesMut
Returns a reference to the read buffer.
sourcepub fn read_buffer_mut(&mut self) -> &mut BytesMut
pub fn read_buffer_mut(&mut self) -> &mut BytesMut
Returns a mutable reference to the read buffer.
Trait Implementations§
source§impl<IO: AsyncReadRent, Codec> AsyncReadRent for FramedRead<IO, Codec>
impl<IO: AsyncReadRent, Codec> AsyncReadRent for FramedRead<IO, Codec>
§type ReadFuture<'a, T> = <FramedInner<IO, Codec, ReadState> as AsyncReadRent>::ReadFuture<'a, T>
where
T: IoBufMut + 'a,
IO: 'a,
Codec: 'a
type ReadFuture<'a, T> = <FramedInner<IO, Codec, ReadState> as AsyncReadRent>::ReadFuture<'a, T> where T: IoBufMut + 'a, IO: 'a, Codec: 'a
The future of read Result<size, buffer>
§type ReadvFuture<'a, T> = <FramedInner<IO, Codec, ReadState> as AsyncReadRent>::ReadvFuture<'a, T>
where
T: IoVecBufMut + 'a,
IO: 'a,
Codec: 'a
type ReadvFuture<'a, T> = <FramedInner<IO, Codec, ReadState> as AsyncReadRent>::ReadvFuture<'a, T> where T: IoVecBufMut + 'a, IO: 'a, Codec: 'a
The future of readv Result<size, buffer>
source§fn read<T: IoBufMut>(&mut self, buf: T) -> Self::ReadFuture<'_, T>
fn read<T: IoBufMut>(&mut self, buf: T) -> Self::ReadFuture<'_, T>
Same as read(2)
source§fn readv<T: IoVecBufMut>(&mut self, buf: T) -> Self::ReadvFuture<'_, T>
fn readv<T: IoVecBufMut>(&mut self, buf: T) -> Self::ReadvFuture<'_, T>
Same as readv(2)
source§impl<Codec: Decoder, IO: AsyncReadRent, AnyCodec> NextWithCodec<Codec> for FramedRead<IO, AnyCodec>
impl<Codec: Decoder, IO: AsyncReadRent, AnyCodec> NextWithCodec<Codec> for FramedRead<IO, AnyCodec>
type Item = Result<<Codec as Decoder>::Item, <Codec as Decoder>::Error>
type NextFuture<'a> = impl Future<Output = Option<<FramedRead<IO, AnyCodec> as NextWithCodec<Codec>>::Item>> + 'a where Self: 'a, Codec: 'a
fn next_with<'a>(&'a mut self, codec: &'a mut Codec) -> Self::NextFuture<'_>
source§impl<IO, Codec> Stream for FramedRead<IO, Codec>where
IO: AsyncReadRent,
Codec: Decoder,
impl<IO, Codec> Stream for FramedRead<IO, Codec>where IO: AsyncReadRent, Codec: Decoder,
§type NextFuture<'a> = <FramedInner<IO, Codec, ReadState> as Stream>::NextFuture<'a>
where
Self: 'a
type NextFuture<'a> = <FramedInner<IO, Codec, ReadState> as Stream>::NextFuture<'a> where Self: 'a
Future representing the next value of the stream.
source§fn next(&mut self) -> Self::NextFuture<'_>
fn next(&mut self) -> Self::NextFuture<'_>
Attempt to pull out the next value of this stream, registering the
current task for wakeup if the value is not yet available, and returning
None if the stream is exhausted.Auto Trait Implementations§
impl<IO, Codec> RefUnwindSafe for FramedRead<IO, Codec>where Codec: RefUnwindSafe, IO: RefUnwindSafe,
impl<IO, Codec> Send for FramedRead<IO, Codec>where Codec: Send, IO: Send,
impl<IO, Codec> Sync for FramedRead<IO, Codec>where Codec: Sync, IO: Sync,
impl<IO, Codec> Unpin for FramedRead<IO, Codec>where Codec: Unpin, IO: Unpin,
impl<IO, Codec> UnwindSafe for FramedRead<IO, Codec>where Codec: UnwindSafe, IO: UnwindSafe,
Blanket Implementations§
source§impl<A> AsyncReadRentExt for Awhere
A: AsyncReadRent + ?Sized,
impl<A> AsyncReadRentExt for Awhere A: AsyncReadRent + ?Sized,
§type ReadExactFuture<'a, T: IoBufMut + 'a> = impl Future<Output = (Result<usize, Error>, T)> + 'a
where
A: 'a
type ReadExactFuture<'a, T: IoBufMut + 'a> = impl Future<Output = (Result<usize, Error>, T)> + 'a where A: 'a
The future of Result<size, buffer>
source§fn read_exact<T>(
&mut self,
buf: T
) -> <A as AsyncReadRentExt>::ReadExactFuture<'_, T>where
T: 'static + IoBufMut,
fn read_exact<T>( &mut self, buf: T ) -> <A as AsyncReadRentExt>::ReadExactFuture<'_, T>where T: 'static + IoBufMut,
Read until buf capacity is fulfilled
§type ReadVectoredExactFuture<'a, T: IoVecBufMut + 'a> = impl Future<Output = (Result<usize, Error>, T)> + 'a
where
A: 'a
type ReadVectoredExactFuture<'a, T: IoVecBufMut + 'a> = impl Future<Output = (Result<usize, Error>, T)> + 'a where A: 'a
The future of Result<size, buffer>
source§fn read_vectored_exact<T>(
&mut self,
buf: T
) -> <A as AsyncReadRentExt>::ReadVectoredExactFuture<'_, T>where
T: 'static + IoVecBufMut,
fn read_vectored_exact<T>( &mut self, buf: T ) -> <A as AsyncReadRentExt>::ReadVectoredExactFuture<'_, T>where T: 'static + IoVecBufMut,
Readv until buf capacity is fulfilled
source§fn read_u8(&mut self) -> <A as AsyncReadRentExt>::ReadU8Future<'_>
fn read_u8(&mut self) -> <A as AsyncReadRentExt>::ReadU8Future<'_>
Read number in async way
§type ReadU16Future<'a> = impl Future<Output = Result<u16, Error>> + 'a
where
A: 'a
type ReadU16Future<'a> = impl Future<Output = Result<u16, Error>> + 'a where A: 'a
Read number result
source§fn read_u16(&mut self) -> <A as AsyncReadRentExt>::ReadU16Future<'_>
fn read_u16(&mut self) -> <A as AsyncReadRentExt>::ReadU16Future<'_>
Read number in async way
§type ReadU32Future<'a> = impl Future<Output = Result<u32, Error>> + 'a
where
A: 'a
type ReadU32Future<'a> = impl Future<Output = Result<u32, Error>> + 'a where A: 'a
Read number result
source§fn read_u32(&mut self) -> <A as AsyncReadRentExt>::ReadU32Future<'_>
fn read_u32(&mut self) -> <A as AsyncReadRentExt>::ReadU32Future<'_>
Read number in async way
§type ReadU64Future<'a> = impl Future<Output = Result<u64, Error>> + 'a
where
A: 'a
type ReadU64Future<'a> = impl Future<Output = Result<u64, Error>> + 'a where A: 'a
Read number result
source§fn read_u64(&mut self) -> <A as AsyncReadRentExt>::ReadU64Future<'_>
fn read_u64(&mut self) -> <A as AsyncReadRentExt>::ReadU64Future<'_>
Read number in async way
§type ReadU128Future<'a> = impl Future<Output = Result<u16, Error>> + 'a
where
A: 'a
type ReadU128Future<'a> = impl Future<Output = Result<u16, Error>> + 'a where A: 'a
Read number result
source§fn read_u128(&mut self) -> <A as AsyncReadRentExt>::ReadU128Future<'_>
fn read_u128(&mut self) -> <A as AsyncReadRentExt>::ReadU128Future<'_>
Read number in async way
source§fn read_i8(&mut self) -> <A as AsyncReadRentExt>::ReadI8Future<'_>
fn read_i8(&mut self) -> <A as AsyncReadRentExt>::ReadI8Future<'_>
Read number in async way
§type ReadI16Future<'a> = impl Future<Output = Result<i16, Error>> + 'a
where
A: 'a
type ReadI16Future<'a> = impl Future<Output = Result<i16, Error>> + 'a where A: 'a
Read number result
source§fn read_i16(&mut self) -> <A as AsyncReadRentExt>::ReadI16Future<'_>
fn read_i16(&mut self) -> <A as AsyncReadRentExt>::ReadI16Future<'_>
Read number in async way
§type ReadI32Future<'a> = impl Future<Output = Result<i32, Error>> + 'a
where
A: 'a
type ReadI32Future<'a> = impl Future<Output = Result<i32, Error>> + 'a where A: 'a
Read number result
source§fn read_i32(&mut self) -> <A as AsyncReadRentExt>::ReadI32Future<'_>
fn read_i32(&mut self) -> <A as AsyncReadRentExt>::ReadI32Future<'_>
Read number in async way
§type ReadI64Future<'a> = impl Future<Output = Result<i64, Error>> + 'a
where
A: 'a
type ReadI64Future<'a> = impl Future<Output = Result<i64, Error>> + 'a where A: 'a
Read number result
source§fn read_i64(&mut self) -> <A as AsyncReadRentExt>::ReadI64Future<'_>
fn read_i64(&mut self) -> <A as AsyncReadRentExt>::ReadI64Future<'_>
Read number in async way
§type ReadI128Future<'a> = impl Future<Output = Result<i128, Error>> + 'a
where
A: 'a
type ReadI128Future<'a> = impl Future<Output = Result<i128, Error>> + 'a where A: 'a
Read number result
source§fn read_i128(&mut self) -> <A as AsyncReadRentExt>::ReadI128Future<'_>
fn read_i128(&mut self) -> <A as AsyncReadRentExt>::ReadI128Future<'_>
Read number in async way
§type ReadF32Future<'a> = impl Future<Output = Result<f32, Error>> + 'a
where
A: 'a
type ReadF32Future<'a> = impl Future<Output = Result<f32, Error>> + 'a where A: 'a
Read number result
source§fn read_f32(&mut self) -> <A as AsyncReadRentExt>::ReadF32Future<'_>
fn read_f32(&mut self) -> <A as AsyncReadRentExt>::ReadF32Future<'_>
Read number in async way
§type ReadF64Future<'a> = impl Future<Output = Result<f64, Error>> + 'a
where
A: 'a
type ReadF64Future<'a> = impl Future<Output = Result<f64, Error>> + 'a where A: 'a
Read number result
source§fn read_f64(&mut self) -> <A as AsyncReadRentExt>::ReadF64Future<'_>
fn read_f64(&mut self) -> <A as AsyncReadRentExt>::ReadF64Future<'_>
Read number in async way
§type ReadU8LEFuture<'a> = impl Future<Output = Result<u8, Error>> + 'a
where
A: 'a
type ReadU8LEFuture<'a> = impl Future<Output = Result<u8, Error>> + 'a where A: 'a
Read number result
source§fn read_u8_le(&mut self) -> <A as AsyncReadRentExt>::ReadU8LEFuture<'_>
fn read_u8_le(&mut self) -> <A as AsyncReadRentExt>::ReadU8LEFuture<'_>
Read number in async way
§type ReadU16LEFuture<'a> = impl Future<Output = Result<u16, Error>> + 'a
where
A: 'a
type ReadU16LEFuture<'a> = impl Future<Output = Result<u16, Error>> + 'a where A: 'a
Read number result
source§fn read_u16_le(&mut self) -> <A as AsyncReadRentExt>::ReadU16LEFuture<'_>
fn read_u16_le(&mut self) -> <A as AsyncReadRentExt>::ReadU16LEFuture<'_>
Read number in async way
§type ReadU32LEFuture<'a> = impl Future<Output = Result<u32, Error>> + 'a
where
A: 'a
type ReadU32LEFuture<'a> = impl Future<Output = Result<u32, Error>> + 'a where A: 'a
Read number result
source§fn read_u32_le(&mut self) -> <A as AsyncReadRentExt>::ReadU32LEFuture<'_>
fn read_u32_le(&mut self) -> <A as AsyncReadRentExt>::ReadU32LEFuture<'_>
Read number in async way
§type ReadU64LEFuture<'a> = impl Future<Output = Result<u64, Error>> + 'a
where
A: 'a
type ReadU64LEFuture<'a> = impl Future<Output = Result<u64, Error>> + 'a where A: 'a
Read number result
source§fn read_u64_le(&mut self) -> <A as AsyncReadRentExt>::ReadU64LEFuture<'_>
fn read_u64_le(&mut self) -> <A as AsyncReadRentExt>::ReadU64LEFuture<'_>
Read number in async way
§type ReadU128LEFuture<'a> = impl Future<Output = Result<u16, Error>> + 'a
where
A: 'a
type ReadU128LEFuture<'a> = impl Future<Output = Result<u16, Error>> + 'a where A: 'a
Read number result
source§fn read_u128_le(&mut self) -> <A as AsyncReadRentExt>::ReadU128LEFuture<'_>
fn read_u128_le(&mut self) -> <A as AsyncReadRentExt>::ReadU128LEFuture<'_>
Read number in async way
§type ReadI8LEFuture<'a> = impl Future<Output = Result<i8, Error>> + 'a
where
A: 'a
type ReadI8LEFuture<'a> = impl Future<Output = Result<i8, Error>> + 'a where A: 'a
Read number result
source§fn read_i8_le(&mut self) -> <A as AsyncReadRentExt>::ReadI8LEFuture<'_>
fn read_i8_le(&mut self) -> <A as AsyncReadRentExt>::ReadI8LEFuture<'_>
Read number in async way
§type ReadI16LEFuture<'a> = impl Future<Output = Result<i16, Error>> + 'a
where
A: 'a
type ReadI16LEFuture<'a> = impl Future<Output = Result<i16, Error>> + 'a where A: 'a
Read number result
source§fn read_i16_le(&mut self) -> <A as AsyncReadRentExt>::ReadI16LEFuture<'_>
fn read_i16_le(&mut self) -> <A as AsyncReadRentExt>::ReadI16LEFuture<'_>
Read number in async way
§type ReadI32LEFuture<'a> = impl Future<Output = Result<i32, Error>> + 'a
where
A: 'a
type ReadI32LEFuture<'a> = impl Future<Output = Result<i32, Error>> + 'a where A: 'a
Read number result
source§fn read_i32_le(&mut self) -> <A as AsyncReadRentExt>::ReadI32LEFuture<'_>
fn read_i32_le(&mut self) -> <A as AsyncReadRentExt>::ReadI32LEFuture<'_>
Read number in async way
§type ReadI64LEFuture<'a> = impl Future<Output = Result<i64, Error>> + 'a
where
A: 'a
type ReadI64LEFuture<'a> = impl Future<Output = Result<i64, Error>> + 'a where A: 'a
Read number result
source§fn read_i64_le(&mut self) -> <A as AsyncReadRentExt>::ReadI64LEFuture<'_>
fn read_i64_le(&mut self) -> <A as AsyncReadRentExt>::ReadI64LEFuture<'_>
Read number in async way
§type ReadI128LEFuture<'a> = impl Future<Output = Result<i128, Error>> + 'a
where
A: 'a
type ReadI128LEFuture<'a> = impl Future<Output = Result<i128, Error>> + 'a where A: 'a
Read number result
source§fn read_i128_le(&mut self) -> <A as AsyncReadRentExt>::ReadI128LEFuture<'_>
fn read_i128_le(&mut self) -> <A as AsyncReadRentExt>::ReadI128LEFuture<'_>
Read number in async way
§type ReadF32LEFuture<'a> = impl Future<Output = Result<f32, Error>> + 'a
where
A: 'a
type ReadF32LEFuture<'a> = impl Future<Output = Result<f32, Error>> + 'a where A: 'a
Read number result
source§fn read_f32_le(&mut self) -> <A as AsyncReadRentExt>::ReadF32LEFuture<'_>
fn read_f32_le(&mut self) -> <A as AsyncReadRentExt>::ReadF32LEFuture<'_>
Read number in async way
§type ReadF64LEFuture<'a> = impl Future<Output = Result<f64, Error>> + 'a
where
A: 'a
type ReadF64LEFuture<'a> = impl Future<Output = Result<f64, Error>> + 'a where A: 'a
Read number result
source§fn read_f64_le(&mut self) -> <A as AsyncReadRentExt>::ReadF64LEFuture<'_>
fn read_f64_le(&mut self) -> <A as AsyncReadRentExt>::ReadF64LEFuture<'_>
Read number in async way
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> StreamExt for Twhere
T: Stream,
impl<T> StreamExt for Twhere T: Stream,
source§fn map<T, F>(self, f: F) -> Map<Self, F>where
F: FnMut(Self::Item) -> T,
Self: Sized,
fn map<T, F>(self, f: F) -> Map<Self, F>where F: FnMut(Self::Item) -> T, Self: Sized,
Maps a stream to a stream of its items.