Enum firefly_types::serial::Request

pub enum Request {
    Cheat(i32, i32),
    Stats(bool),
}

Messages that clients send into the runtime.

Variants

Cheat(i32, i32)

Call the cheat callback with the given two arguments.

It’s up to the app how to handle the passed values, but the most common practice is to treat the first value as the command to execute (for exmaple, 42 for “noclip”) and the second value as the command argument (for example, 0 for “disable” and 1 for “enable”).

Stats(bool)

Turn on/off collection and sending of runtime stats.

Implementations

impl Request

pub fn decode(s: &[u8]) -> Result<Self, Error>

Load request from bytes generated by Request::encode.

Errors

May return an error if the buffer does not contain valid request.

pub fn encode<'b>(&self, buf: &'b mut [u8]) -> Result<&'b mut [u8], Error>

Encode the request using the buffer.

The buffer is required to avoid allocations on the crate side. Use Request::size to calculate the required buffer size.

Errors

May return an error if the buffer is not big enough.

pub fn size(&self) -> usize

Calculate the buffer size required to encode the request.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Request

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Request

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Request