binary_layout/fields/primitive/
mod.rs

1use core::marker::PhantomData;
2
3use crate::endianness::Endianness;
4
5mod copy_access;
6mod nested_access;
7mod slice_access;
8mod view;
9
10pub use copy_access::{FieldCopyAccess, FieldReadExt, FieldWriteExt, NonZeroIsZeroError};
11pub use nested_access::{BorrowingNestedView, NestedViewInfo, OwningNestedView};
12pub use slice_access::FieldSliceAccess;
13pub use view::FieldView;
14
15/// A [PrimitiveField] is a [Field](crate::Field) that directly represents a primitive type like [u8], [i16], ...
16/// See [Field](crate::Field) for more info on this API.
17///
18/// # Example:
19/// ```
20/// use binary_layout::prelude::*;
21///
22/// binary_layout!(my_layout, LittleEndian, {
23///   field_one: u16,
24///   another_field: [u8; 16],
25///   something_else: u32,
26///   tail_data: [u8],
27/// });
28///
29/// fn func(storage_data: &mut [u8]) {
30///   // read some data
31///   let format_version_header: u16 = my_layout::field_one::read(storage_data);
32///   // equivalent: let format_version_header = u16::from_le_bytes((&storage_data[0..2]).try_into().unwrap());
33///
34///   // write some data
35///   my_layout::something_else::write(storage_data, 10);
36///   // equivalent: data_slice[18..22].copy_from_slice(&10u32.to_le_bytes());
37///
38///   // access a data region
39///   let tail_data: &[u8] = my_layout::tail_data::data(storage_data);
40///   // equivalent: let tail_data: &[u8] = &data_slice[22..];
41///
42///   // and modify it
43///   my_layout::tail_data::data_mut(storage_data)[..5].copy_from_slice(&[1, 2, 3, 4, 5]);
44///   // equivalent: data_slice[18..22].copy_from_slice(&[1, 2, 3, 4, 5]);
45/// }
46/// ```
47pub struct PrimitiveField<T: ?Sized, E: Endianness, const OFFSET_: usize> {
48    _p1: PhantomData<T>,
49    _p2: PhantomData<E>,
50}
binary_layout/fields/primitive/mod.rs

binary_layout/fields/primitive/
mod.rs
