Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add try_from_iter for *MemoryRegion and *RegisterData #34

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add try_from_iter for *MemoryRegion and *RegisterData #34

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53fb533
Add try_from_iter for ArrayMemoryRegion and VecMemoryRegion
hdoordt Aug 24, 2023
fd488dd
Add try_from_iter for ArrayRegisterData and VecRegisterData
hdoordt Aug 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 121 additions & 72 deletions core/src/memory_region.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,56 @@ impl<const SIZE: usize> ArrayMemoryRegion<SIZE> {
self.data.set_len(data_len);
self.data.as_mut_ptr().copy_from(data_ptr, data_len);
}

/// Try to build a [ArrayMemoryRegion] from an [IntoIterator<Item = u8>]
pub fn try_from_iter<I: IntoIterator<Item = u8>>(
iter: I,
) -> Result<Self, MemoryRegionFromIterError> {
use MemoryRegionFromIterError::*;
let mut iter = iter.into_iter();

match iter.next() {
Some(MEMORY_REGION_IDENTIFIER) => {}
Some(id) => return Err(InvalidIdentifier(id)),
None => return Err(NotEnoughItems),
}

let start_address = u64::from_le_bytes([
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
]);

let length = u64::from_le_bytes([
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
]);

if length > SIZE as u64 {
return Err(LengthTooBig(length));
}

// This call panics if length > SIZE
// and `iter` does indeed contain more than SIZE items,
// but we've just covered that case
let data = ArrayVec::from_iter(iter.take(length as usize));

Ok(Self {
start_address,
data,
})
}
}

#[cfg(feature = "std")]
Expand Down Expand Up @@ -134,42 +184,7 @@ impl<'a, const SIZE: usize> FromIterator<&'a u8> for ArrayMemoryRegion<SIZE> {

impl<const SIZE: usize> FromIterator<u8> for ArrayMemoryRegion<SIZE> {
fn from_iter<T: IntoIterator<Item = u8>>(iter: T) -> Self {
let mut iter = iter.into_iter();

assert_eq!(
iter.next().unwrap(),
MEMORY_REGION_IDENTIFIER,
"The given iterator is not for a memory region"
);

let start_address = u64::from_le_bytes([
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
]);

let length = u64::from_le_bytes([
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
]);

let data = ArrayVec::from_iter(iter.take(length as usize));

Self {
start_address,
data,
}
Self::try_from_iter(iter).unwrap()
}
}

Expand Down Expand Up @@ -234,6 +249,49 @@ impl VecMemoryRegion {

self.data.as_mut_ptr().copy_from(data_ptr, data_len);
}

/// Try to build a [VecMemoryRegion] from an [IntoIterator<Item = u8>]
pub fn try_from_iter<I: IntoIterator<Item = u8>>(
iter: I,
) -> Result<Self, MemoryRegionFromIterError> {
use MemoryRegionFromIterError::*;
let mut iter = iter.into_iter();

match iter.next() {
Some(MEMORY_REGION_IDENTIFIER) => {}
Some(id) => return Err(InvalidIdentifier(id)),
None => return Err(NotEnoughItems),
}

let start_address = u64::from_le_bytes([
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
]);

let length = u64::from_le_bytes([
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
iter.next().ok_or(NotEnoughItems)?,
]);

let data = Vec::from_iter(iter.take(length as usize));

Ok(Self {
start_address,
data,
})
}
}

#[cfg(feature = "std")]
Expand Down Expand Up @@ -267,42 +325,7 @@ impl<'a> FromIterator<&'a u8> for VecMemoryRegion {
#[cfg(feature = "std")]
impl FromIterator<u8> for VecMemoryRegion {
fn from_iter<T: IntoIterator<Item = u8>>(iter: T) -> Self {
let mut iter = iter.into_iter();

assert_eq!(
iter.next().unwrap(),
MEMORY_REGION_IDENTIFIER,
"The given iterator is not for a memory region"
);

let start_address = u64::from_le_bytes([
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
]);

let length = u64::from_le_bytes([
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
iter.next().unwrap(),
]);

let data = Vec::from_iter(iter.take(length as usize));

Self {
start_address,
data,
}
Self::try_from_iter(iter).unwrap()
}
}

Expand Down Expand Up @@ -433,6 +456,32 @@ impl<'a> Iterator for MemoryRegionIterator<'a> {

impl<'a> ExactSizeIterator for MemoryRegionIterator<'a> {}

#[derive(Debug)]
/// Specifies what went wrong building a [MemoryRegion] from an iterator
pub enum MemoryRegionFromIterError {
/// The given iterator is not for a memory region.
/// First item from iterator yielded invalid identifier. Expected [MEMORY_REGION_IDENTIFIER]
InvalidIdentifier(u8),
/// Iterator specified length too big for declared region
LengthTooBig(u64),
/// Iterator did not yield enough items to build memory region
NotEnoughItems,
}

impl core::fmt::Display for MemoryRegionFromIterError {
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
use MemoryRegionFromIterError::*;
match self {
InvalidIdentifier(id) => write!(f, "Iterator is not for a memory region. Started with {id}, expected {MEMORY_REGION_IDENTIFIER}"),
LengthTooBig(len) => write!(f, "Iterator specified length too big for declared region: {len}"),
NotEnoughItems => write!(f, "Iterator did not yield enough items to build memory region"),
}
}
}

#[cfg(feature = "std")]
impl std::error::Error for MemoryRegionFromIterError {}

#[cfg(test)]
mod tests {
use super::*;
Expand Down
Loading
Loading