Struct TofPacket

pub struct TofPacket {
    pub packet_type: PacketType,
    pub payload: Vec<u8>,
    pub no_write_to_disk: bool,
    pub no_send_over_nw: bool,
    pub creation_time: Instant,
    pub valid: bool,
}

The most basic of all packets

A type and a payload. This wraps all other packets.

Format when in bytestream HEAD : u16 PAYLOAD_SIZE : u32 PAYLOAD : [u8;PAYLOAD_SIZE] TAIL : u16

=> Fixed size is 13

Fields

packet_type: PacketType

Type of the structure encoded in payload

payload: Vec<u8>

The bytestream encoded structure

no_write_to_disk: bool

mark a packet as not eligible to be written to disk

no_send_over_nw: bool

mark a packet as not eligible to be sent over network FIXME - future extension

creation_time: Instant

creation_time for the instance

valid: bool

Implementations

impl TofPacket

pub fn new() -> Self

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

Generate a bytestream of self for ZMQ, prefixed with BRCT so all RBs will see it

pub fn zmq_payload_rb(&self, rb_id: u8) -> Vec<u8>

Generate a bytestream of self for ZMQ, prefixed with RBX, to address only a certain board

pub fn unpack<T>(&self) -> Result<T, SerializationError>

where T: Packable + Serialization,

Unpack the TofPacket and return its content

pub fn age(&self) -> u64

Trait Implementations

impl CRSerializeable for TofPacket

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 TofPacket

fn clone(&self) -> TofPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TofPacket

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

Formats the value using the given formatter.

impl Default for TofPacket

fn default() -> Self

Returns the “default value” for a type.

impl Display for TofPacket

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

Formats the value using the given formatter.

impl Frameable for TofPacket

const CRFRAMEOBJECT_TYPE: CRFrameObjectType = CRFrameObjectType::TofPacket

fn pack(&self) -> CRFrameObject

where Self: CRSerializeable,

Wrap myself in a TofPacket

impl From<&CPUMoniData> for TofPacket

fn from(moni: &CPUMoniData) -> Self

Converts to this type from the input type.

impl From<&MasterTriggerEvent> for TofPacket

fn from(mt: &MasterTriggerEvent) -> TofPacket

Converts to this type from the input type.

impl From<&MtbMoniData> for TofPacket

fn from(moni: &MtbMoniData) -> TofPacket

Converts to this type from the input type.

impl From<&RBCalibrations> for TofPacket

fn from(calib: &RBCalibrations) -> Self

Converts to this type from the input type.

impl From<&RBEvent> for TofPacket

fn from(event: &RBEvent) -> Self

Converts to this type from the input type.

impl From<&RBEventHeader> for TofPacket

fn from(ev_header: &RBEventHeader) -> TofPacket

Converts to this type from the input type.

impl From<&RBWaveform> for TofPacket

FIXME - all these can go away now, because we have the Packable trait! Amazing!

fn from(rbwave: &RBWaveform) -> Self

Converts to this type from the input type.

impl From<&TofCommand> for TofPacket

fn from(cmd: &TofCommand) -> Self

Converts to this type from the input type.

impl From<&TofEvent> for TofPacket

fn from(event: &TofEvent) -> Self

Converts to this type from the input type.

impl From<&TofEventSummary> for TofPacket

fn from(tsum: &TofEventSummary) -> Self

Converts to this type from the input type.

impl From<&TofPacket> for RBEvent

fn from(pk: &TofPacket) -> Self

Converts to this type from the input type.

impl From<&mut RBCalibrations> for TofPacket

fn from(calib: &mut RBCalibrations) -> Self

Converts to this type from the input type.

impl From<&mut TofEvent> for TofPacket

fn from(event: &mut TofEvent) -> Self

Converts to this type from the input type.

impl PartialEq for TofPacket

Implement because TofPacket saves the creation time, which never will be the same for 2 different instances

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialization for TofPacket

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

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

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

Decode a serializable from a bytestream

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

Encode a serializable to a bytestream

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.

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

where Self: Sized,

Decode a serializable directly from a TofPacket

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.