Struct TofPacket

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

Internal Tof communication protocol. Simple, yet powerful

A TofPacket has the following layout on disk HEAD : u16 = 0xAAAA TYPE : u8 = PacketType SIZE : u32 PAYLOAD : [u8;6-SIZE] TAIL : u16 = 0x5555

The total packet size is thus 13 + SIZE

Fields

packet_type: TofPacketType

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: TofPackable + Serialization,

Unpack the TofPacket and return its content

pub fn age(&self) -> u64

Trait Implementations

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 DataReader<TofPacket> for TofPacketReader

fn prime_next_file(&mut self) -> Option<usize>

Get the next file ready

fn get_header0(&self) -> u8

fn get_header1(&self) -> u8

fn get_file_idx(&self) -> usize

The current index corresponding to the file the reader is currently working on

fn set_file_idx(&mut self, file_idx: usize)

Set a new file idx corresponding to a file the reader is currently working on

fn get_filenames(&self) -> &Vec<String>

Return all filenames the reader is primed with

fn set_cursor(&mut self, pos: usize)

Manage the internal cursor attribute

fn set_file_reader(&mut self, reader: BufReader<File>)

reset a new reader

fn read_next(&mut self) -> Option<TofPacket>

Get the next frame/packet from the stream. Can be used to implement iterators

fn get_current_filename(&self) -> Option<&str>

The name of the file the reader is currently working on

fn first(&mut self) -> Option<T>

Get the first entry in all of the files the reader is primed with

fn last(&mut self) -> Option<T>

Get the last entry in all of the files the reader is primed with

fn rewind(&mut self) -> Result<()>

Rewind the current file and set the file index to the first file, so data can be read again from the beginning

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: Serialization,

Wrap myself in a CRFrameObject

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

Byte marker to mark beginning of payload

const TAIL: u16 = 21_845u16

Byte marker to mark end of payload

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_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.