Skip to main content

FramedReader

Struct FramedReader 

Source
pub struct FramedReader<R> { /* private fields */ }
Expand description

Reads packets from an AsyncRead.

Implementations§

Source§

impl<R: AsyncRead + Unpin> FramedReader<R>

Source

pub fn new(inner: R) -> Self

Wraps a reader.

Source

pub fn decoder(&mut self) -> &mut FrameDecoder

The frame decoder (compression, encryption, filter, limits, stats).

Source

pub fn get_mut(&mut self) -> &mut R

The underlying reader.

Source

pub async fn read_packet(&mut self) -> Result<Option<RawPacket>, FrameError>

Reads the next packet that passes the filter. Ok(None) on a clean end of stream (no partial frame buffered).

Cancel safe: if the future is dropped, no data is lost.

Trait Implementations§

Source§

impl<R: Debug> Debug for FramedReader<R>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> !UnwindSafe for FramedReader<R>

§

impl<R> Forget for FramedReader<R>

§

impl<R> Freeze for FramedReader<R>
where R: Freeze,

§

impl<R> RefUnwindSafe for FramedReader<R>
where R: RefUnwindSafe,

§

impl<R> Send for FramedReader<R>
where R: Send,

§

impl<R> Sync for FramedReader<R>
where R: Sync,

§

impl<R> Unpin for FramedReader<R>
where R: Unpin,

§

impl<R> UnsafeUnpin for FramedReader<R>
where R: UnsafeUnpin,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.