Struct flatdata::StructBuf

pub struct StructBuf<T> where
    T: RefFactory + NoOverlap,  { /* fields omitted */ }

A container holding a single flatdata struct in memory, and providing read and write access to it.

Used in combination with ArchiveBuilder to serialize single struct resources, cf. coappearances example.

A struct buffer derefs (const and mut) to a reference of the underlying struct, therefore, struct getters and setters can be used directly on buffer.

Examples

struct A {
    x : u32 : 16;
    y : u32 : 16;
}

archive X {
   data : A;
}

let storage = MemoryResourceStorage::new("/root/structbuf");
let builder = XBuilder::new(storage.clone()).expect("failed to create builder");
let mut a = StructBuf::<A>::new();
a.get_mut().set_x(1);
a.get_mut().set_y(2);
builder.set_data(a.get());

println!("{:?}", storage);
let archive = X::open(storage).expect("failed to open");
let view = archive.data();

assert_eq!(view.x(), 1);
assert_eq!(view.y(), 2);

Methods

impl<T> StructBuf<T> where
    T: RefFactory + NoOverlap, 

pub fn new() -> Self

Creates an empty struct buffer.

All fields are set to 0.

pub fn get(&self) -> <T as Struct>::Item

Get the stored object

pub fn get_mut(&mut self) -> <T as Struct>::ItemMut

Get the mutable version of the stored object

pub fn as_bytes(&self) -> &[u8]

Returns a raw bytes representation of the buffer.

Trait Implementations

impl<T> AsRef<[u8]> for StructBuf<T> where
    T: RefFactory + NoOverlap, 

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<T> Default for StructBuf<T> where
    T: RefFactory + NoOverlap, 

fn default() -> Self

Returns the "default value" for a type.

impl<T> Debug for StructBuf<T> where
    T: RefFactory + NoOverlap, 

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

Formats the value using the given formatter.