Struct TofCommandV2

pub struct TofCommandV2 {
    pub command_code: TofCommandCode,
    pub payload: Vec<u8>,
}

A general command class with an arbitrary payload

Since the commands should in general be small the maixmal payload size is limited to 256 bytes

All commands will get broadcasted and the receiver has to figure out if they have to rect to that command

Fields

command_code: TofCommandCode

payload: Vec<u8>

Implementations

impl TofCommandV2

pub fn new() -> Self

pub fn forge_changerunconfig(key_value: &Vec<String>) -> Self

In case the command is supposed to change the next run configuration we can create it with this function

Arguments

• key_value : a list of keys and a single value (last item of the list

pub fn extract_changerunconfig(&self) -> Option<Vec<String>>

After the command has been unpackt, reconstruct the key/value string

Trait Implementations

impl Clone for TofCommandV2

fn clone(&self) -> TofCommandV2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TofCommandV2

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

Formats the value using the given formatter.

impl Default for TofCommandV2

fn default() -> Self

Returns the “default value” for a type.

impl Display for TofCommandV2

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

Formats the value using the given formatter.

impl FromRandom for TofCommandV2

fn from_random() -> Self

impl Packable for TofCommandV2

const PACKET_TYPE: PacketType = PacketType::TofCommandV2

fn pack(&self) -> TofPacket

where Self: Serialization,

Wrap myself in a TofPacket

impl PartialEq for TofCommandV2

fn eq(&self, other: &TofCommandV2) -> 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 TofCommandV2

const HEAD: u16 = 43_690u16

const TAIL: u16 = 21_845u16

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

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

impl StructuralPartialEq for TofCommandV2