pub struct EscapedDataReader<'a, R> { /* private fields */ }Expand description
AsyncRead instance that returns an unescaped DATA stream.
Note that:
- If a line (as defined by b“\r\n“ endings) starts with a b’.’, it is an “escaping” dot that is not part of the actual contents of the line.
- If a line is exactly b“.\r\n“, it is the last line of the stream this stream will give. It is not part of the actual contents of the message.
Implementations§
Source§impl<'a, R> EscapedDataReader<'a, R>where
R: AsyncRead,
impl<'a, R> EscapedDataReader<'a, R>where
R: AsyncRead,
pub fn new(buf: &'a mut [u8], unhandled: Range<usize>, read: R) -> Self
Sourcepub fn is_finished(&self) -> bool
pub fn is_finished(&self) -> bool
Returns true iff the message has been successfully streamed
to completion
Sourcepub fn complete(&mut self)
pub fn complete(&mut self)
Asserts that the full message has been read (ie.
.is_finished() would
return true), then marks this reader as complete.
Note that this should be called before saving the stream,
given that until .is_finished() has returned true it’s not
yet sure whether the stream ended due to connection loss or
thanks to the end of data marker being reached.
Sourcepub fn get_unhandled(&self) -> Option<Range<usize>>
pub fn get_unhandled(&self) -> Option<Range<usize>>
Returns the range of data in the buf passed to new that
contains data that hasn’t been handled yet (ie. what followed
the end-of-data marker) if complete() has been called, and
None otherwise.
Trait Implementations§
Source§impl<'a, R> AsyncRead for EscapedDataReader<'a, R>where
R: AsyncRead,
impl<'a, R> AsyncRead for EscapedDataReader<'a, R>where
R: AsyncRead,
impl<'pin, 'a, R> Unpin for EscapedDataReader<'a, R>where
PinnedFieldsOf<__EscapedDataReader<'pin, 'a, R>>: Unpin,
Auto Trait Implementations§
impl<'a, R> Freeze for EscapedDataReader<'a, R>where
R: Freeze,
impl<'a, R> RefUnwindSafe for EscapedDataReader<'a, R>where
R: RefUnwindSafe,
impl<'a, R> Send for EscapedDataReader<'a, R>where
R: Send,
impl<'a, R> Sync for EscapedDataReader<'a, R>where
R: Sync,
impl<'a, R> !UnwindSafe for EscapedDataReader<'a, R>
Blanket Implementations§
Source§impl<R> AsyncReadExt for R
impl<R> AsyncReadExt for R
Source§fn chain<R>(self, next: R) -> Chain<Self, R>
fn chain<R>(self, next: R) -> Chain<Self, R>
Creates an adaptor which will chain this stream with another. Read more
Source§fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,
fn read<'a>(&'a mut self, buf: &'a mut [u8]) -> Read<'a, Self>where
Self: Unpin,
Tries to read some bytes directly into the given
buf in asynchronous
manner, returning a future type. Read moreSource§fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>],
) -> ReadVectored<'a, Self>where
Self: Unpin,
fn read_vectored<'a>(
&'a mut self,
bufs: &'a mut [IoSliceMut<'a>],
) -> ReadVectored<'a, Self>where
Self: Unpin,
Creates a future which will read from the
AsyncRead into bufs using vectored
IO operations. Read moreSource§fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,
fn read_exact<'a>(&'a mut self, buf: &'a mut [u8]) -> ReadExact<'a, Self>where
Self: Unpin,
Creates a future which will read exactly enough bytes to fill
buf,
returning an error if end of file (EOF) is hit sooner. Read moreSource§fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>where
Self: Unpin,
fn read_to_end<'a>(&'a mut self, buf: &'a mut Vec<u8>) -> ReadToEnd<'a, Self>where
Self: Unpin,
Creates a future which will read all the bytes from this
AsyncRead. Read moreSource§fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String,
) -> ReadToString<'a, Self>where
Self: Unpin,
fn read_to_string<'a>(
&'a mut self,
buf: &'a mut String,
) -> ReadToString<'a, Self>where
Self: Unpin,
Creates a future which will read all the bytes from this
AsyncRead. Read moreSource§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