embassy-sync

Crates

git

Versions

default

Flavors

embassy_sync::pipe

Struct DynamicReader

Source
pub struct DynamicReader<'p> { /* private fields */ }
Expand description

Read-only access to a [DynamicPipe].

Implementations§

Source§

impl<'p> DynamicReader<'p>

Source

pub fn read<'a>(&'a self, buf: &'a mut [u8]) -> DynamicReadFuture<'a>

Read some bytes from the pipe.

See Pipe::read()

Source

pub fn try_read(&self, buf: &mut [u8]) -> Result<usize, TryReadError>

Attempt to immediately read some bytes from the pipe.

See Pipe::try_read()

Source

pub fn fill_buf(&mut self) -> DynamicFillBufFuture<'_>

Return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

If no bytes are currently available to read, this function waits until at least one byte is available.

If the reader is at end-of-file (EOF), an empty slice is returned.

Source

pub fn try_fill_buf(&mut self) -> Result<&[u8], TryReadError>

Try returning contents of the internal buffer.

If no bytes are currently available to read, this function returns Err(TryReadError::Empty).

If the reader is at end-of-file (EOF), an empty slice is returned.

Source

pub fn consume(&mut self, amt: usize)

Tell this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to fill_buf.

Trait Implementations§

Source§

impl<'p, M, const N: usize> From<Reader<'p, M, N>> for DynamicReader<'p>
where M: RawMutex,

Source§

fn from(value: Reader<'p, M, N>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'p> Freeze for DynamicReader<'p>

§

impl<'p> !RefUnwindSafe for DynamicReader<'p>

§

impl<'p> !Send for DynamicReader<'p>

§

impl<'p> !Sync for DynamicReader<'p>

§

impl<'p> Unpin for DynamicReader<'p>

§

impl<'p> !UnwindSafe for DynamicReader<'p>

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.