Enum TofResponse

pub enum TofResponse {
    Success(u32),
    GeneralFail(u32),
    EventNotReady(u32),
    SerializationIssue(u32),
    ZMQProblem(u32),
    TimeOut(u32),
    NotImplemented(u32),
    AccessDenied(u32),
    Unknown,
}

Each TofCommand triggers a TofResponse in reply

The responses are general classes, which carry a more specific 32-bit response code.

Variants

Success(u32)

GeneralFail(u32)

A unknown problem led to a non-execution of the command. The error code should tell more. A re-issue of the command might solve the problem.

EventNotReady(u32)

The requested event is not ready yet. This means, it is still lingering in the caches of the readout boards. If this problem occurs many times, it might be helpful to reduce the cache size of the readoutboards to be more responsive. The response code is the specific event id we initially requested.

SerializationIssue(u32)

Somehwere, a serialization error happened. It might be worth trying to execute that command again.

ZMQProblem(u32)

TimeOut(u32)

NotImplemented(u32)

AccessDenied(u32)

Unknown

Trait Implementations

impl Clone for TofResponse

fn clone(&self) -> TofResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TofResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TofResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TofResponse

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

Formats the value using the given formatter.

impl From<(u8, u32)> for TofResponse

fn from(pair: (u8, u32)) -> TofResponse

Converts to this type from the input type.

impl From<TofResponse> for u8

fn from(input: TofResponse) -> u8

Converts to this type from the input type.

impl PartialEq for TofResponse

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

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 = 9usize

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 to_bytestream(&self) -> Vec<u8>

Encode a serializable to a bytestream

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

Decode a serializable from 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.

impl Serialize for TofResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TofPackable for TofResponse

const TOF_PACKET_TYPE: TofPacketType = TofPacketType::TofResponse

const TOF_PACKET_TYPE_ALT: TofPacketType = TofPacketType::Unknown

fn pack(&self) -> TofPacket

where Self: Serialization,

Wrap myself in a TofPacket

impl Copy for TofResponse

impl StructuralPartialEq for TofResponse