Struct flipdot_core::Data

pub struct Data<'a>(/* private fields */);

Owned or borrowed data to be placed in a Frame.

Since the data length in the Frame will be represented as a single byte, that length cannot exceed 255 (0xFF). Data is responsible for maintaining this invariant.

Examples

use flipdot_core::{Address, Data, Frame, MsgType};
let data = Data::try_new(vec![1, 2, 3])?; // Ok since length under 255
let frame = Frame::new(Address(2), MsgType(1), data);

Implementations

impl<'a> Data<'a>

pub fn try_new<T: Into<Cow<'a, [u8]>>>(data: T) -> Result<Self, FrameError>

Creates a new Data containing owned or borrowed data.

Since the data length in the Frame will be represented as a single byte, that length cannot exceed 255 (0xFF).

Errors

Returns FrameError::DataTooLong if the data length is greater than 255 (0xFF).

Examples

use flipdot_core::Data;
let data = Data::try_new(vec![1, 2, 3])?;
assert_eq!(vec![1, 2, 3], data.get().as_ref());

Borrowed data can also be used:

let bytes = vec![1, 2, 3];
let data = Data::try_new(&bytes)?;
assert_eq!(vec![1, 2, 3], data.get().as_ref());

This will fail since the passed-in vector is too large:

let result = Data::try_new(vec![0; 1000]);
assert!(result.is_err());

pub fn get(&self) -> &Cow<'a, [u8]>

Returns a reference to the inner Cow<[u8]>.

Examples

let data = Data::try_new(vec![])?;
assert!(data.get().is_empty());

Trait Implementations

impl<'a> Clone for Data<'a>

fn clone(&self) -> Data<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Data<'a>

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

Formats the value using the given formatter.

impl From<&'static [u8; 0]> for Data<'_>

fn from(value: &'static [u8; 0]) -> Data<'_>

Converts to this type from the input type.

impl From<&'static [u8; 1]> for Data<'_>

fn from(value: &'static [u8; 1]) -> Data<'_>

Converts to this type from the input type.

impl From<&'static [u8; 2]> for Data<'_>

fn from(value: &'static [u8; 2]) -> Data<'_>

Converts to this type from the input type.

impl From<&'static [u8; 3]> for Data<'_>

fn from(value: &'static [u8; 3]) -> Data<'_>

Converts to this type from the input type.

impl From<&'static [u8; 4]> for Data<'_>

fn from(value: &'static [u8; 4]) -> Data<'_>

Converts to this type from the input type.

impl<'a> Hash for Data<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq for Data<'a>

fn eq(&self, other: &Data<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for Data<'a>

impl<'a> StructuralPartialEq for Data<'a>