servicepoint/servicepoint-binding-c
0
2
Fork 0
Code Issues 1 Pull requests 1 Projects Releases 2 Packages Wiki Activity Actions

move data_ref to trait

Browse source
This commit is contained in:
Vinzenz Schroeter 2024-05-18 11:11:15 +02:00
parent bcf040911d
commit d5e08faeb1
11 changed files with 81 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

25
servicepoint2/src/bit_vec.rs
View file

@ -1,3 +1,5 @@
use crate::DataRef;
/// A vector of bits
#[derive(Clone, PartialEq)]
pub struct BitVec {
@ -83,11 +85,6 @@ impl BitVec {
self.data.is_empty()
}
/// Get the underlying bits in their raw packed bytes form
pub fn mut_data_ref(&mut self) -> &mut [u8] {
self.data.as_mut_slice()
}
/// Calculates the byte index and bitmask for a specific bit in the vector
fn get_indexes(&self, bit_index: usize) -> (usize, u8) {
if bit_index >= self.size {
@ -104,6 +101,16 @@ impl BitVec {
}
}
impl DataRef for BitVec {
fn data_ref_mut(&mut self) -> &mut [u8] {
self.data.as_mut_slice()
}
fn data_ref(&self) -> &[u8] {
self.data.as_slice()
}
}
impl From<BitVec> for Vec<u8> {
/// Turns the `BitVec` into the underlying `Vec<u8>`
fn from(value: BitVec) -> Self {
@ -133,7 +140,7 @@ impl std::fmt::Debug for BitVec {
#[cfg(feature = "c_api")]
pub mod c_api {
use crate::{BitVec, CByteSlice};
use crate::{BitVec, CByteSlice, DataRef};
/// Creates a new `BitVec` instance.
/// The returned instance has to be freed with `bit_vec_dealloc`.
@ -220,7 +227,7 @@ pub mod c_api {
pub unsafe extern "C" fn sp2_bit_vec_unsafe_data_ref(
this: *mut BitVec,
) -> CByteSlice {
let data = (*this).mut_data_ref();
let data = (*this).data_ref_mut();
CByteSlice {
start: data.as_mut_ptr_range().start,
length: data.len(),
@ -230,7 +237,7 @@ pub mod c_api {
#[cfg(test)]
mod tests {
use crate::BitVec;
use crate::{BitVec, DataRef};
#[test]
fn fill() {
@ -280,7 +287,7 @@ mod tests {
fn mut_data_ref() {
let mut vec = BitVec::new(8 * 3);
let data_ref = vec.mut_data_ref();
let data_ref = vec.data_ref_mut();
data_ref.copy_from_slice(&[0x40, 0x10, 0x00]);
assert_eq!(vec.data, [0x40, 0x10, 0x00]);

27
servicepoint2/src/byte_grid.rs
View file

@ -1,4 +1,4 @@
use crate::Grid;
use crate::{DataRef, Grid};
/// A 2D grid of bytes
#[derive(Debug, Clone, PartialEq)]
@ -36,11 +36,6 @@ impl ByteGrid {
}
}
/// Get the underlying byte rows
pub fn mut_data_ref(&mut self) -> &mut [u8] {
self.data.as_mut_slice()
}
fn check_indexes(&self, x: usize, y: usize) {
if x >= self.width {
panic!("cannot access byte {x}-{y} because x is outside of bounds 0..{}", self.width)
@ -78,6 +73,17 @@ impl Grid<u8> for ByteGrid {
}
}
impl DataRef for ByteGrid {
/// Get the underlying byte rows mutable
fn data_ref_mut(&mut self) -> &mut [u8] {
self.data.as_mut_slice()
}
/// Get the underlying byte rows read only
fn data_ref(&self) -> &[u8] {
self.data.as_slice()
}
}
impl From<ByteGrid> for Vec<u8> {
/// Turn into the underlying `Vec<u8>` containing the rows of bytes.
@ -88,8 +94,9 @@ impl From<ByteGrid> for Vec<u8> {
#[cfg(feature = "c_api")]
pub mod c_api {
use crate::{ByteGrid, CByteSlice};
use crate::data_ref::DataRef;
use crate::grid::Grid;
use crate::{ByteGrid, CByteSlice};
/// Creates a new `ByteGrid` instance.
/// The returned instance has to be freed with `byte_grid_dealloc`.
@ -190,7 +197,7 @@ pub mod c_api {
pub unsafe extern "C" fn sp2_byte_grid_unsafe_data_ref(
this: *mut ByteGrid,
) -> CByteSlice {
let data = (*this).mut_data_ref();
let data = (*this).data_ref_mut();
CByteSlice {
start: data.as_mut_ptr_range().start,
length: data.len(),
@ -200,7 +207,7 @@ pub mod c_api {
#[cfg(test)]
mod tests {
use crate::{ByteGrid, Grid};
use crate::{ByteGrid, DataRef, Grid};
#[test]
fn fill() {
@ -247,7 +254,7 @@ mod tests {
fn mut_data_ref() {
let mut vec = ByteGrid::new(2, 2);
let data_ref = vec.mut_data_ref();
let data_ref = vec.data_ref_mut();
data_ref.copy_from_slice(&[1, 2, 3, 4]);
assert_eq!(vec.data, [1, 2, 3, 4]);

5
servicepoint2/src/command.rs
View file

@ -1,6 +1,9 @@
use crate::command_code::CommandCode;
use crate::compression::{into_compressed, into_decompressed};
use crate::{BitVec, ByteGrid, CompressionCode, Grid, Header, Packet, PixelGrid, TILE_SIZE};
use crate::{
BitVec, ByteGrid, CompressionCode, Grid, Header, Packet, PixelGrid,
TILE_SIZE,
};
/// An origin marks the top left position of a window sent to the display.
#[derive(Debug, Clone, Copy, PartialEq)]

8
servicepoint2/src/connection.rs
View file

@ -38,20 +38,20 @@ impl Connection {
/// # Examples
///
/// ```rust
/// use servicepoint2::CompressionCode;
/// use servicepoint2::{Command, CompressionCode, Grid, PixelGrid};
/// let connection = servicepoint2::Connection::open("172.23.42.29:2342")
/// .expect("connection failed");
///
/// // turn off all pixels
/// connection.send(servicepoint2::Command::Clear.into())
/// connection.send(Command::Clear.into())
/// .expect("send failed");
///
/// // turn on all pixels
/// let mut pixels = servicepoint2::PixelGrid::max_sized();
/// let mut pixels = PixelGrid::max_sized();
/// pixels.fill(true);
///
/// // send pixels to display
/// connection.send(servicepoint2::Command::BitmapLinearWin(servicepoint2::Origin(0, 0), pixels, CompressionCode::Lzma).into())
/// connection.send(Command::BitmapLinearWin(servicepoint2::Origin(0, 0), pixels, CompressionCode::Uncompressed).into())
/// .expect("send failed");
/// ```
pub fn send(&self, packet: Packet) -> Result<(), std::io::Error> {

11
servicepoint2/src/data_ref.rs Normal file
View file

@ -0,0 +1,11 @@
/// A trait for getting the underlying raw byte slices of data containers.
///
/// The expectation is that you can create an equal instance with this data given the additional
/// metadata needed.
pub trait DataRef {
/// Get the underlying bytes writable.
fn data_ref_mut(&mut self) -> &mut [u8];
/// Get the underlying bytes read-only.
fn data_ref(&self) -> &[u8];
}

6
servicepoint2/src/lib.rs
View file

@ -3,9 +3,10 @@ pub use crate::byte_grid::ByteGrid;
pub use crate::command::{Brightness, Command, Offset, Origin, Size};
pub use crate::compression_code::CompressionCode;
pub use crate::connection::Connection;
pub use crate::data_ref::DataRef;
pub use crate::grid::Grid;
pub use crate::packet::{Header, Packet, Payload};
pub use crate::pixel_grid::PixelGrid;
pub use crate::grid::Grid;
use std::time::Duration;
#[cfg(feature = "c_api")]
@ -19,9 +20,10 @@ mod command_code;
mod compression;
mod compression_code;
mod connection;
mod data_ref;
mod grid;
mod packet;
mod pixel_grid;
mod grid;
/// size of a single tile in one dimension
pub const TILE_SIZE: u16 = 8;

36
servicepoint2/src/pixel_grid.rs
View file

@ -1,4 +1,4 @@
use crate::{BitVec, Grid, PIXEL_HEIGHT, PIXEL_WIDTH};
use crate::{BitVec, DataRef, Grid, PIXEL_HEIGHT, PIXEL_WIDTH};
/// A grid of pixels stored in packed bytes.
#[derive(Debug, Clone, PartialEq)]
@ -58,10 +58,6 @@ impl PixelGrid {
}
}
pub fn mut_data_ref(&mut self) -> &mut [u8] {
self.bit_vec.mut_data_ref()
}
fn check_indexes(&self, x: usize, y: usize) {
if x >= self.width {
panic!("cannot access pixel {x}-{y} because x is outside of bounds 0..{}", self.width)
@ -95,6 +91,16 @@ impl Grid<bool> for PixelGrid {
}
}
impl DataRef for PixelGrid {
fn data_ref_mut(&mut self) -> &mut [u8] {
self.bit_vec.data_ref_mut()
}
fn data_ref(&self) -> &[u8] {
self.bit_vec.data_ref()
}
}
impl From<PixelGrid> for Vec<u8> {
/// Turns a `PixelGrid` into the underlying `Vec<u8>`.
fn from(value: PixelGrid) -> Self {
@ -105,7 +111,7 @@ impl From<PixelGrid> for Vec<u8> {
#[cfg(feature = "c_api")]
pub mod c_api {
use crate::c_slice::CByteSlice;
use crate::{Grid, PixelGrid};
use crate::{DataRef, Grid, PixelGrid};
/// Creates a new `PixelGrid` instance.
/// The returned instance has to be freed with `pixel_grid_dealloc`.
@ -206,7 +212,7 @@ pub mod c_api {
pub unsafe extern "C" fn sp2_pixel_grid_unsafe_data_ref(
this: *mut PixelGrid,
) -> CByteSlice {
let data = (*this).mut_data_ref();
let data = (*this).data_ref_mut();
CByteSlice {
start: data.as_mut_ptr_range().start,
length: data.len(),
@ -216,18 +222,18 @@ pub mod c_api {
#[cfg(test)]
mod tests {
use crate::{Grid, PixelGrid};
use crate::{DataRef, Grid, PixelGrid};
#[test]
fn fill() {
let mut grid = PixelGrid::new(8, 2);
assert_eq!(grid.mut_data_ref(), [0x00, 0x00]);
assert_eq!(grid.data_ref(), [0x00, 0x00]);
grid.fill(true);
assert_eq!(grid.mut_data_ref(), [0xFF, 0xFF]);
assert_eq!(grid.data_ref(), [0xFF, 0xFF]);
grid.fill(false);
assert_eq!(grid.mut_data_ref(), [0x00, 0x00]);
assert_eq!(grid.data_ref(), [0x00, 0x00]);
}
#[test]
@ -238,7 +244,7 @@ mod tests {
grid.set(5, 0, true);
grid.set(1, 1, true);
assert_eq!(grid.mut_data_ref(), [0x04, 0x40]);
assert_eq!(grid.data_ref(), [0x04, 0x40]);
assert!(grid.get(5, 0));
assert!(grid.get(1, 1));
@ -254,11 +260,11 @@ mod tests {
}
}
assert_eq!(grid.mut_data_ref(), [0xAA, 0x55, 0xAA]);
assert_eq!(grid.data_ref(), [0xAA, 0x55, 0xAA]);
let data: Vec<u8> = grid.into();
let mut grid = PixelGrid::load(8, 3, &data);
assert_eq!(grid.mut_data_ref(), [0xAA, 0x55, 0xAA]);
let grid = PixelGrid::load(8, 3, &data);
assert_eq!(grid.data_ref(), [0xAA, 0x55, 0xAA]);
}
}