Struct Reader

Source
pub struct Reader<B> { /* private fields */ }
Expand description

A Buf adapter which implements io::Read for the inner value.

This struct is generally created by calling reader() on Buf. See documentation of reader() for more details.

Implementations§

Source§

impl<B: Buf> Reader<B>

Source

pub fn get_ref(&self) -> &B

Gets a reference to the underlying Buf.

It is inadvisable to directly read from the underlying Buf.

§Examples
use embedrs_bytes::Buf;
use std::io::{self, Cursor};

let mut buf = Cursor::new(b"hello world").reader();

assert_eq!(0, buf.get_ref().position());
Source

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

Gets a mutable reference to the underlying Buf.

It is inadvisable to directly read from the underlying Buf.

§Examples
use embedrs_bytes::Buf;
use std::io::{self, Cursor};

let mut buf = Cursor::new(b"hello world").reader();
let mut dst = vec![];

buf.get_mut().set_position(2);
io::copy(&mut buf, &mut dst).unwrap();

assert_eq!(*dst, b"llo world"[..]);
Source

pub fn into_inner(self) -> B

Consumes this Reader, returning the underlying value.

§Examples
use embedrs_bytes::Buf;
use std::io::{self, Cursor};

let mut buf = Cursor::new(b"hello world").reader();
let mut dst = vec![];

io::copy(&mut buf, &mut dst).unwrap();

let buf = buf.into_inner();
assert_eq!(0, buf.remaining());

Trait Implementations§

Source§

impl<B: Debug> Debug for Reader<B>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<B> Freeze for Reader<B>
where B: Freeze,

§

impl<B> RefUnwindSafe for Reader<B>
where B: RefUnwindSafe,

§

impl<B> Send for Reader<B>
where B: Send,

§

impl<B> Sync for Reader<B>
where B: Sync,

§

impl<B> Unpin for Reader<B>
where B: Unpin,

§

impl<B> UnwindSafe for Reader<B>
where B: UnwindSafe,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.