Struct Sink 

pub struct Sink { /* private fields */ }

A mock which can act as a data sink.

An instance of the mock can be constructed using the builder-style methods. Each item added by the builder methods will be returned in-order when data is written to the Sink.

Data can then be written to it using the embedded_io::Write or embedded_io_async::Write traits.

Blocking Example

use embedded_io::Write;

let mut mock_sink = Sink::new()
                        .accept_data(12)
                        .error(MockError(embedded_io::ErrorKind::BrokenPipe));

let data_bytes = "hello world!".as_bytes();
let res = mock_sink.write_all(data_bytes);
assert!(res.is_ok());

let res = mock_sink.write(data_bytes);
assert!(res.is_err_and(|e| e == MockError(embedded_io::ErrorKind::BrokenPipe)));

Async Example

use embedded_io_async::Write;

let mut mock_sink = Sink::new()
                        .accept_data(12)
                        .error(MockError(embedded_io::ErrorKind::BrokenPipe));

let data_bytes = "hello world!".as_bytes();
let res = mock_sink.write_all(data_bytes).await;
assert!(res.is_ok());

let res = mock_sink.write(data_bytes).await;
assert!(res.is_err_and(|e| e == MockError(embedded_io::ErrorKind::BrokenPipe)));

Implementations

impl Sink

pub fn new() -> Self

Create a new empty Sink.

pub fn accept_data(self, n: usize) -> Self

Accept n bytes of data written to the Sink

pub fn error(self, e: MockError) -> Self

Add an error value to the Sink

pub fn closed(self) -> Self

Add a “connection closed” item to the Sink. When written, this will return Ok(0) to the caller (which might then result in an error value if they used the write_all method instead of write).

pub fn is_consumed(&self) -> bool

Check if all of the provided items were consumed

pub fn into_inner_data(self) -> Vec<u8>

Get the inner data that has been received from the writer

pub fn owned_handle(&mut self) -> OwnedHandle<'_, Self>

Get an OwnedHandle containing the Sink

Trait Implementations

impl Debug for Sink

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

Formats the value using the given formatter.

impl Default for Sink

fn default() -> Sink

Returns the “default value” for a type.

impl ErrorType for Sink

type Error = MockError

Error type of all the IO operations on this type.

impl Write for Sink

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

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

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

Flush this output stream, blocking until all intermediately buffered contents reach their destination.

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

Write an entire buffer into this writer.

fn write_fmt( &mut self, fmt: Arguments<'_>, ) -> Result<(), WriteFmtError<Self::Error>>

Write a formatted string into this writer, returning any error encountered.

impl Write for Sink

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.