Struct CRFrame

pub struct CRFrame {
    pub index: HashMap<String, (u64, CRFrameObjectType)>,
    pub bytestorage: Vec<u8>,
}

The central data container of the caraspace suite.

A CRFrame can hold multiple CRFrameObjects and is basically a little sclerite of the entire skeleton.

Fields

index: HashMap<String, (u64, CRFrameObjectType)>

bytestorage: Vec<u8>

Implementations

impl CRFrame

pub fn new() -> Self

pub fn serialize_index(&self) -> Vec<u8>

pub fn parse_index( stream: &Vec<u8>, pos: &mut usize, ) -> HashMap<String, (u64, CRFrameObjectType)>

pub fn delete(&self, name: &str) -> Result<CRFrame, CRSerializationError>

Delete a CRFrameObject by this name from the frame

To delete multiple objects, delete calls can be chained

Arguments:

• name : The name of the FrameObject to delte (must be in index)

Returns:

A complete copy of self, without the given object.

pub fn put<T: CRSerializeable + Frameable>(&mut self, object: T, name: String)

Store any eligible object in the frame

Eligible object must implement the “Frameable” trait

pub fn has(&self, name: &str) -> bool

Check if the frame contains an object with the given name

Arguments:

• name : The name of the object as it appears in the index

pub fn get_fobject( &self, name: &str, ) -> Result<CRFrameObject, CRSerializationError>

pub fn get<T: CRSerializeable + Frameable>( &self, name: String, ) -> Result<T, CRSerializationError>

pub fn show_frame(&self) -> String

A verbose display of the frame content

Trait Implementations

impl CRSerializeable for CRFrame

fn deserialize( stream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, CRSerializationError>

Decode a serializable from a bytestream

fn serialize(&self) -> Vec<u8>

Encode a serializable to a bytestream

const CRHEAD: u16 = 43_690u16

const CRTAIL: u16 = 21_845u16

const CRSIZE: usize = 0usize

The SIZE is the size of the serialized bytestream INCLUDING 4 bytes for head and tail bytes. In case the struct does NOT HAVE a fixed size, SIZE will be 0 (so default value of the trait

fn verify_fixed( stream: &Vec<u8>, pos: &mut usize, ) -> Result<(), CRSerializationError>

Verify that the serialized representation of the struct has the correct size, including header + footer.

impl Clone for CRFrame

fn clone(&self) -> CRFrame

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CRFrame

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

Formats the value using the given formatter.

impl Display for CRFrame

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

Formats the value using the given formatter.