Struct SmlReaderBuilder

pub struct SmlReaderBuilder<Buf: Buffer> { /* private fields */ }

Builder struct for SmlReader that allows configuring the internal buffer type.

See here for an explanation of the different internal buffer types and how to use the builder to customize them.

Implementations

impl<Buf: Buffer> SmlReaderBuilder<Buf>

pub fn from_reader<R: Read>(self, reader: R) -> SmlReader<IoReader<R>, Buf>

Available on crate feature std only.

Build an SmlReader from a type implementing std::io::Read.

This function is available only if sml-rs is built with the "std" feature.

Examples

let data = [1, 2, 3];
let cursor = std::io::Cursor::new(data);  // implements std::io::Read
let reader = SmlReader::with_static_buffer::<1024>().from_reader(cursor);

pub fn from_eh_reader<R: Read<u8, Error = E>, E>( self, reader: R, ) -> SmlReader<EhReader<R, E>, Buf>

Available on crate feature embedded_hal only.

Build an SmlReader from a type implementing embedded_hal::serial::Read<u8>.

This function is available only if sml-rs is built with the "embedded-hal" feature.

Examples

// usually provided by hardware abstraction layers (HALs) for specific chips
// let pin = ...;

let reader = SmlReader::with_static_buffer::<1024>().from_eh_reader(pin);

pub fn from_slice(self, reader: &[u8]) -> SmlReader<SliceReader<'_>, Buf>

Build an SmlReader from a slice of bytes.

Examples

let data: &[u8] = &[1, 2, 3];
let reader = SmlReader::with_static_buffer::<1024>().from_slice(data);

pub fn from_iterator<B, I>( self, iter: I, ) -> SmlReader<IterReader<I::IntoIter, B>, Buf>

where I: IntoIterator<Item = B>, B: Borrow<u8>,

Build an SmlReader from a type that can be turned into a byte iterator.

Examples

let data: [u8; 3] = [1, 2, 3];
let builder = SmlReader::with_static_buffer::<1024>();
let reader = builder.clone().from_iterator(data.clone());      // [u8; 3]
let reader = builder.clone().from_iterator(&data);             // &[u8; 3]
let reader = builder.clone().from_iterator(data.as_slice());   // &[u8]
let reader = builder.clone().from_iterator(data.iter());       // impl Iterator<Item = &u8>
let reader = builder.clone().from_iterator(data.into_iter());  // impl Iterator<Item = u8>

Trait Implementations

impl<Buf: Buffer> Clone for SmlReaderBuilder<Buf>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.