Trait Serialization

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

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

    // Provided methods
    fn verify_fixed(
        stream: &Vec<u8>,
        pos: &mut usize,
    ) -> Result<(), SerializationError> { ... }
    fn from_tofpacket(packet: &TofPacket) -> Result<Self, SerializationError>
       where Self: Sized { ... }
    fn to_bytestream(&self) -> Vec<u8> { ... }
    fn from_slice(
        _slice: &[u8],
        _start_pos: usize,
    ) -> Result<Self, SerializationError>
       where Self: Sized { ... }
    fn to_slice(&self) -> &[u8] 
       where Self: Sized { ... }
}

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

Required Associated Constants

const HEAD: u16

const TAIL: u16

Provided Associated Constants

const SIZE: 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

Required Methods

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

where Self: Sized,

Decode a serializable from a bytestream

Provided Methods

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.

fn from_tofpacket(packet: &TofPacket) -> Result<Self, SerializationError>

where Self: Sized,

Decode a serializable directly from a TofPacket

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

Encode a serializable to a bytestream

fn from_slice( _slice: &[u8], _start_pos: usize, ) -> Result<Self, SerializationError>

where Self: Sized,

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

where Self: Sized,

Construct byte slice out of self.

Can not fail.

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.

Implementors

impl Serialization for TofCommand

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 9usize

impl Serialization for TofResponse

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 9usize

impl Serialization for RBCalibrations

const SIZE: usize = 294_918usize

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for RBCalibrationsFlightT

const SIZE: usize = 18_437usize

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for RBCalibrationsFlightV

const SIZE: usize = 55_305usize

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for AnalysisEngineConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 65usize

impl Serialization for DataPublisherConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 24usize

impl Serialization for LTBThresholdConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 17usize

impl Serialization for PreampBiasConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 69usize

impl Serialization for RBChannelMaskConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 14usize

impl Serialization for RunConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 29usize

impl Serialization for TOFEventBuilderConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 46usize

impl Serialization for TofRBConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 25usize

impl Serialization for TofRunConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 12usize

impl Serialization for TriggerConfig

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 26usize

impl Serialization for TofCommandV2

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for MasterTriggerEvent

const SIZE: usize = 0usize

const TAIL: u16 = 21_845u16

const HEAD: u16 = 43_690u16

impl Serialization for RBEvent

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for RBEventHeader

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 30usize

impl Serialization for RBWaveform

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for RBEventMemoryView

const SIZE: usize = 18_530usize

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for TofEvent

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for TofEventHeader

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 43usize

impl Serialization for TofEventSummary

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for TofHit

const HEAD: u16 = 61_680u16

const TAIL: u16 = 3_855u16

const SIZE: usize = 30usize

impl Serialization for EVTBLDRHeartbeat

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 156usize

impl Serialization for HeartBeatDataSink

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 84usize

impl Serialization for MTBHeartbeat

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 68usize

impl Serialization for RBPing

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 13usize

impl Serialization for CPUMoniData

const SIZE: usize = 41usize

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for LTBMoniData

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 25usize

impl Serialization for MtbMoniData

const SIZE: usize = 24usize

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

impl Serialization for PAMoniData

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 133usize

impl Serialization for PBMoniData

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 93usize

impl Serialization for RBMoniData

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 151usize

impl Serialization for TofPacket

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 0usize

impl Serialization for TofDetectorStatus

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

const SIZE: usize = 44usize