Struct CRFrameObject

pub struct CRFrameObject {
    pub version: u8,
    pub ftype: CRFrameObjectType,
    pub payload: Vec<u8>,
}

A Caraspace object, that can be stored within a frame.

For the connaiseur: This is basically a TofPacket on steroids

Fields

version: u8

ftype: CRFrameObjectType

payload: Vec<u8>

serialized representation of the content object

Implementations

impl CRFrameObject

pub fn new() -> Self

pub fn size(&self) -> usize

Size of the serialized object, including header and footer in bytes

pub fn extract<T>(&self) -> Result<T, CRSerializationError>

where T: Frameable + CRSerializeable,

Unpack the TofPacket and return its content

Trait Implementations

impl CRSerializeable for CRFrameObject

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

where Self: Sized,

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 CRFrameObject

fn clone(&self) -> CRFrameObject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CRFrameObject

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

Formats the value using the given formatter.

impl Display for CRFrameObject

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

Formats the value using the given formatter.