feat: cleaning of all the ssv_memory and ssvlib_demo to get a cleaner cps::lire_carte API

This commit is contained in:
2024-08-02 00:08:49 +02:00
parent 0be0b08f89
commit e9ef6cbb4b
6 changed files with 425 additions and 653 deletions

View File

@ -1,11 +1,11 @@
/**
* Provide functions to manipulate raw memory from SSV library.
*/
// TODO : Est-ce qu'on pourrait/devrait définir un type custom pour représenter les tableaux de bytes ?
/// # SSV Memory
/// Provide functions to manipulate raw memory from SSV library.
///
use std::convert::TryFrom;
// TODO : Est-ce qu'on pourrait/devrait définir un type custom pour représenter les tableaux de bytes ?
#[derive(PartialEq, Debug)]
struct ElementSize {
pub size: usize,
@ -16,11 +16,11 @@ impl TryFrom<&[u8]> for ElementSize {
type Error = &'static str;
fn try_from(bytes: &[u8]) -> Result<Self, Self::Error> {
/* Longueur:
* - si le bit de poids fort du premier octet est à 0, la longueur est codée sur un octet
* - si le bit de poids fort du premier octet est à 1, les 7 bits de poids faible codent le nombre d'octets utilisés pour coder la longueur
*/
if bytes.len() == 0 {
/* Longueur:
* - si le bit de poids fort du premier octet est à 0, la longueur est codée sur un octet
* - si le bit de poids fort du premier octet est à 1, les 7 bits de poids faible codent le nombre d'octets utilisés pour coder la longueur
*/
if bytes.is_empty() {
return Err("Empty bytes input");
}
@ -41,7 +41,7 @@ impl TryFrom<&[u8]> for ElementSize {
// u32::from_be_bytes() requires a 4 bytes array
let mut padded_bytes = [0u8; 4];
padded_bytes[size_bytes_len..].copy_from_slice(&size_bytes);
padded_bytes[size_bytes_len..].copy_from_slice(size_bytes);
element_size.size = u32::from_be_bytes(padded_bytes) as usize;
element_size.pad += size_bytes_len;
@ -62,7 +62,10 @@ impl<'a> From<&'a [u8]> for Block<'a> {
let mut offset = 0;
let id = u16::from_be_bytes(bytes[..2].try_into().unwrap());
offset += 2;
let ElementSize { size: block_size, pad } = bytes[2..].try_into().unwrap();
let ElementSize {
size: block_size,
pad,
} = bytes[2..].try_into().unwrap();
offset += pad;
let raw_content = &bytes[offset..];
let mut field_offset = 0;
@ -90,9 +93,9 @@ pub struct Field<'a> {
impl<'a> From<&'a [u8]> for Field<'a> {
fn from(bytes: &'a [u8]) -> Self {
let ElementSize { size, pad } = bytes.try_into().unwrap();
let contenu = &bytes[pad..pad+size];
let contenu = &bytes[pad..pad + size];
Field {
size: pad+size,
size: pad + size,
content: contenu,
}
}
@ -138,10 +141,7 @@ mod test_element_size {
fn null_size() {
let bytes: &[u8] = &[];
let result: Result<ElementSize, &str> = bytes.try_into();
assert_eq!(
result,
Err("Empty bytes input"),
);
assert_eq!(result, Err("Empty bytes input"),);
}
#[test]
@ -162,10 +162,7 @@ mod test_element_size {
let bytes: &[u8] = &[0b_1000_0101_u8, 1, 1, 1, 1, 1];
let result: Result<ElementSize, &str> = bytes.try_into();
assert_eq!(
result,
Err("Invalid memory: size is too big"),
);
assert_eq!(result, Err("Invalid memory: size is too big"),);
}
}
@ -175,28 +172,27 @@ mod test_field {
#[test]
fn short_size() {
let bytes: &[u8] = &[51,
1, 48, 1, 56, 11, 57, 57, 55, 48, 48,
53, 50, 52, 49, 57, 52, 1, 52, 2, 50,
50, 17, 80, 72, 65, 82, 77, 65, 67, 73,
69, 78, 48, 48, 53, 50, 52, 49, 57, 9,
70, 82, 65, 78, 67, 79, 73, 83, 69, 1,
84,
let bytes: &[u8] = &[
51, 1, 48, 1, 56, 11, 57, 57, 55, 48, 48, 53, 50, 52, 49, 57, 52, 1, 52, 2, 50, 50, 17,
80, 72, 65, 82, 77, 65, 67, 73, 69, 78, 48, 48, 53, 50, 52, 49, 57, 9, 70, 82, 65, 78,
67, 79, 73, 83, 69, 1, 84,
];
let element: Field = bytes.try_into().unwrap();
let element: Field = bytes.into();
assert_eq!(element.size, 52);
assert_eq!(element.content[..5], [1, 48, 1, 56, 11]);
}
#[test]
fn long_size() {
let mut bytes_vec = vec![0b_1000_0010_u8,
0b_0000_0001_u8, 0b_0000_0000_u8, // size = 256
let mut bytes_vec = vec![
0b_1000_0010_u8,
0b_0000_0001_u8,
0b_0000_0000_u8, // size = 256
];
// Add 256 bytes to the content
bytes_vec.append(&mut vec![1; 256]);
let bytes: &[u8] = &bytes_vec;
let element: Field = bytes.try_into().unwrap();
let element: Field = bytes.into();
assert_eq!(element.size, 259);
assert_eq!(element.content.len(), 256);
}
@ -208,12 +204,8 @@ mod test_block {
#[test]
fn test_francoise_pharmacien0052419_partial_block_1() {
let bytes: &[u8] = &[
1, 48,
1, 56,
11, 57, 57, 55, 48, 48, 53, 50, 52, 49, 57, 52,
];
let bytes: &[u8] = &[1, 48, 1, 56, 11, 57, 57, 55, 48, 48, 53, 50, 52, 49, 57, 52];
let field1: Field = bytes.into();
assert_eq!(field1.size, 2);
assert_eq!(field1.content, &[48]);
@ -224,13 +216,16 @@ mod test_block {
let field3: Field = bytes[field1.size + field2.size..].into();
assert_eq!(field3.size, 12);
assert_eq!(field3.content, &[57, 57, 55, 48, 48, 53, 50, 52, 49, 57, 52]);
assert_eq!(
field3.content,
&[57, 57, 55, 48, 48, 53, 50, 52, 49, 57, 52]
);
}
#[test]
fn test_francoise_pharmacien0052419() {
let bytes: &[u8] = &[
0, 1, 51, // 3
0, 1, 51, // 3
1, 48, // 2
1, 56, // 2
11, 57, 57, 55, 48, 48, 53, 50, 52, 49, 57, 52, // 12
@ -239,32 +234,13 @@ mod test_block {
17, 80, 72, 65, 82, 77, 65, 67, 73, 69, 78, 48, 48, 53, 50, 52, 49, 57, // 18
9, 70, 82, 65, 78, 67, 79, 73, 83, 69, // 10
1, 84, // 2
// total: 54
0, 2, 83,
1, 1,
1, 48,
1, 49,
2, 56, 54,
1, 49,
9, 48, 66, 48, 50, 50, 49, 57, 53, 56,
1, 56,
24, 80, 72, 65, 82, 77, 65, 67, 73, 69, 32, 68, 85, 32, 67, 69, 78, 84, 82, 69, 50, 50, 49, 57, 53,
8, 48, 48, 50, 48, 50, 52, 49, 57,
1, 56,
0,
1, 48,
1, 49,
2, 53, 48,
2, 49, 48,
2, 48, 48,
1, 48,
1, 48,
1, 48,
1, 49,
1, 49,
// total: 54
0, 2, 83, 1, 1, 1, 48, 1, 49, 2, 56, 54, 1, 49, 9, 48, 66, 48, 50, 50, 49, 57, 53, 56,
1, 56, 24, 80, 72, 65, 82, 77, 65, 67, 73, 69, 32, 68, 85, 32, 67, 69, 78, 84, 82, 69,
50, 50, 49, 57, 53, 8, 48, 48, 50, 48, 50, 52, 49, 57, 1, 56, 0, 1, 48, 1, 49, 2, 53,
48, 2, 49, 48, 2, 48, 48, 1, 48, 1, 48, 1, 48, 1, 49, 1, 49,
];
let first_block: Block = bytes.into();
assert_eq!(first_block.id, 1);
assert_eq!(first_block.size, 54);
@ -284,7 +260,7 @@ mod test_decode_ssv_memory {
#[test]
fn test_francoise_pharmacien0052419() {
let bytes: &[u8] = &[
0, 1, 51, // 3
0, 1, 51, // 3
1, 48, // 2
1, 56, // 2
11, 57, 57, 55, 48, 48, 53, 50, 52, 49, 57, 52, // 12
@ -293,32 +269,13 @@ mod test_decode_ssv_memory {
17, 80, 72, 65, 82, 77, 65, 67, 73, 69, 78, 48, 48, 53, 50, 52, 49, 57, // 18
9, 70, 82, 65, 78, 67, 79, 73, 83, 69, // 10
1, 84, // 2
// total: 54
0, 2, 83,
1, 1,
1, 48,
1, 49,
2, 56, 54,
1, 49,
9, 48, 66, 48, 50, 50, 49, 57, 53, 56,
1, 56,
24, 80, 72, 65, 82, 77, 65, 67, 73, 69, 32, 68, 85, 32, 67, 69, 78, 84, 82, 69, 50, 50, 49, 57, 53,
8, 48, 48, 50, 48, 50, 52, 49, 57,
1, 56,
0,
1, 48,
1, 49,
2, 53, 48,
2, 49, 48,
2, 48, 48,
1, 48,
1, 48,
1, 48,
1, 49,
1, 49,
// total: 54
0, 2, 83, 1, 1, 1, 48, 1, 49, 2, 56, 54, 1, 49, 9, 48, 66, 48, 50, 50, 49, 57, 53, 56,
1, 56, 24, 80, 72, 65, 82, 77, 65, 67, 73, 69, 32, 68, 85, 32, 67, 69, 78, 84, 82, 69,
50, 50, 49, 57, 53, 8, 48, 48, 50, 48, 50, 52, 49, 57, 1, 56, 0, 1, 48, 1, 49, 2, 53,
48, 2, 49, 48, 2, 48, 48, 1, 48, 1, 48, 1, 48, 1, 49, 1, 49,
];
let blocks = decode_ssv_memory(&bytes, bytes.len());
let blocks = decode_ssv_memory(bytes, bytes.len());
assert_eq!(blocks.len(), 2);
}
}
}