Struct block_device_adapters::BufStream

pub struct BufStream<T: BlockDevice<SIZE>, const SIZE: usize, const ALIGN: usize>
where
    Align<ALIGN>: Alignment,
{ /* private fields */ }

A Stream wrapper for accessing a stream in block sized chunks.

BufStream<T, const SIZE: usize, const ALIGN: usize can be initialized with the following parameters.

• T: The inner stream.
• SIZE: The size of the block, this dictates the size of the internal buffer.
• ALIGN: The alignment of the internal buffer.

If the buf provided to either Read::read or Write::write meets the following conditions the buf will be used directly instead of the intermediate buffer to avoid unnecessary copies:

• buf.len() is a multiple of block size
• buf has the same alignment as the internal buffer
• The byte address of the inner device is aligned to a block size.

BufStream<T, const SIZE: usize, const ALIGN: usize implements the embedded_io_async traits, and implicitly handles the RMW (Read, Modify, Write) cycle for you.

Implementations

impl<T: BlockDevice<SIZE>, const SIZE: usize, const ALIGN: usize> BufStream<T, SIZE, ALIGN>

where Align<ALIGN>: Alignment,

pub fn new(inner: T) -> Self

Create a new BufStream around a hardware block device.

pub fn into_inner(self) -> T

Returns inner object.

Trait Implementations

impl<T: BlockDevice<SIZE>, const SIZE: usize, const ALIGN: usize> ErrorType for BufStream<T, SIZE, ALIGN>

where Align<ALIGN>: Alignment,

type Error = BufStreamError<<T as BlockDevice<SIZE>>::Error>

Error type of all the IO operations on this type.

impl<T: BlockDevice<SIZE>, const SIZE: usize, const ALIGN: usize> Read for BufStream<T, SIZE, ALIGN>

where Align<ALIGN>: Alignment,

async fn read(&mut self, buf: &mut [u8]) -> Result<usize, Self::Error>

Read some bytes from this source into the specified buffer, returning how many bytes were read.

async fn read_exact( &mut self, buf: &mut [u8] ) -> Result<(), ReadExactError<Self::Error>>

Read the exact number of bytes required to fill buf.

impl<T: BlockDevice<SIZE>, const SIZE: usize, const ALIGN: usize> Seek for BufStream<T, SIZE, ALIGN>

where Align<ALIGN>: Alignment,

async fn seek(&mut self, pos: SeekFrom) -> Result<u64, Self::Error>

Seek to an offset, in bytes, in a stream.

async fn rewind(&mut self) -> Result<(), Self::Error>

Rewind to the beginning of a stream.

async fn stream_position(&mut self) -> Result<u64, Self::Error>

Returns the current seek position from the start of the stream.

impl<T: BlockDevice<SIZE>, const SIZE: usize, const ALIGN: usize> Write for BufStream<T, SIZE, ALIGN>

where Align<ALIGN>: Alignment,

async fn write(&mut self, buf: &[u8]) -> Result<usize, Self::Error>

Write a buffer into this writer, returning how many bytes were written.

async fn flush(&mut self) -> Result<(), Self::Error>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

async fn write_all(&mut self, buf: &[u8]) -> Result<(), Self::Error>

Write an entire buffer into this writer.