Trait Serialization

Source

pub trait Serialization {
    const HEAD: u16 = 0xAAAA;
    const TAIL: u16 = 0x5555;
    const SIZE: usize = 0;

    // Required method
    fn from_bytestream(
        bytestream: &Vec<u8>,
        pos: &mut usize,
    ) -> Result<Self, SerializationError>
       where Self: Sized;

    // Provided methods
    fn guess_size(
        stream: &Vec<u8>,
        pos: usize,
        offset: usize,
    ) -> Result<(usize, usize, usize), SerializationError> { ... }
    fn verify_fixed(
        stream: &Vec<u8>,
        pos: &mut usize,
    ) -> Result<(), SerializationError> { ... }
    fn from_bytestream_alt(
        bytestream: &Vec<u8>,
        pos: &mut usize,
    ) -> Result<Self, SerializationError>
       where Self: Sized { ... }
    fn to_bytestream(&self) -> Vec<u8> ⓘ { ... }
}

Expand description

Encode/decode structs to Vec::<u8> to write to a file or send over the network

Provided Associated Constants§

Source

const HEAD: u16 = 0xAAAA

Byte marker to mark beginning of payload

Source

const TAIL: u16 = 0x5555

Byte marker to mark end of payload

Source

const SIZE: usize = 0

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

Required Methods§

Source

fn from_bytestream( bytestream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>
where Self: Sized,

Decode a serializable from a bytestream

§Arguments:

bytestream : bytes including the ones which should be decoded
pos : first byte in the bytestream which is part of the expected payload

Provided Methods§

Source

fn guess_size( stream: &Vec<u8>, pos: usize, offset: usize, ) -> Result<(usize, usize, usize), SerializationError>

Guess the size of te packet. This can be a preformance issue if te offset position is far off

This will not advance the pos marker!

Source

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

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

Will panic for variable sized structs.

Source

fn from_bytestream_alt( bytestream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>
where Self: Sized,

Decode a serializable from a bytestream. This provides an alternative method to get the packet. If not implemented, it will be the same as from_bytestream.

§Arguments:

bytestream : bytes including the ones which should be decoded
pos : first byte in the bytestream which is part of the expected payload

Source

fn to_bytestream(&self) -> Vec<u8> ⓘ

Encode a serializable to a bytestream

This shall return a representation of the struct in such a way that to_bytestream and from_bytestream are inverse operations.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait Serialization Copy item path

Provided Associated Constants§

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

const SIZE: usize = 0

Required Methods§

fn from_bytestream( bytestream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>where Self: Sized,

§Arguments:

Provided Methods§

fn guess_size( stream: &Vec<u8>, pos: usize, offset: usize, ) -> Result<(usize, usize, usize), SerializationError>

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

fn from_bytestream_alt( bytestream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>where Self: Sized,

§Arguments:

fn to_bytestream(&self) -> Vec<u8> ⓘ

Dyn Compatibility§

Implementors§

impl Serialization for TofResponse

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

const SIZE: usize = 9

impl Serialization for RBCalibrationFlightT

const SIZE: usize

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

impl Serialization for RBCalibrationFlightV

const SIZE: usize

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

impl Serialization for RBCalibrations

const SIZE: usize

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

impl Serialization for RBEvent

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

impl Serialization for RBEventHeader

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

const SIZE: usize = 30

impl Serialization for RBWaveform

const HEAD: u16 = 43690

const TAIL: u16 = 21845

const SIZE: usize

impl Serialization for TelemetryEvent

impl Serialization for TofEvent

const HEAD: u16 = 43690

const TAIL: u16 = 21845

impl Serialization for TofHit

const HEAD: u16 = 61680

const TAIL: u16 = 3855

const SIZE: usize = 44

impl Serialization for CPUMoniData

const SIZE: usize = 41

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

impl Serialization for DataSinkHB

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

const SIZE: usize = 84

impl Serialization for EventBuilderHB

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

const SIZE: usize = 156

impl Serialization for MasterTriggerHB

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

const SIZE: usize = 111

impl Serialization for LTBMoniData

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

const SIZE: usize

impl Serialization for MtbMoniData

const SIZE: usize = 24

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

impl Serialization for PAMoniData

const HEAD: u16 = 0xAAAA

const TAIL: u16 = 0x5555

const SIZE: usize

impl Serialization for PBMoniData

Trait Serialization

fn from_bytestream( bytestream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>
where Self: Sized,

fn from_bytestream_alt( bytestream: &Vec<u8>, pos: &mut usize, ) -> Result<Self, SerializationError>
where Self: Sized,