Struct Command 

pub struct Command { /* private fields */ }

Main command payload structure.

Implementations

impl Command

pub fn new_control() -> Command

Create a new, empty control packet.

pub fn new_cancellation() -> Command

Create a new, empty cancellation packet.

pub fn new_validation_ack() -> Command

Create a new, empty validation ACK packet.

pub fn new_exec_ack() -> Command

Create a new, empty execution ACK packet.

pub fn new_query_ack() -> Command

Create a new, empty query ACK packet.

pub fn message_id(&self) -> u32

Get the packet message ID.

pub fn set_message_id(&mut self, message_id: u32)

Set the packet message ID.

pub fn cam(&self) -> ControlAckMode

Get the packet’s Control Ack Mode (CAM)

pub fn set_cam(&mut self, mode: ControlAckMode)

Set the packet’s Control Ack Mode (CAM)

Example

use vita49::{prelude::*, ControlAckMode, ActionMode};
let mut packet = Vrt::new_control_packet();
let command_mut = packet.payload_mut().command_mut().unwrap();
let mut cam = ControlAckMode::default();
cam.set_action_mode(ActionMode::Execute);
command_mut.set_cam(cam);
assert_eq!(command_mut.cam().action_mode(), ActionMode::Execute);

pub fn controllee_id(&self) -> Option<u32>

Get the controllee identifier.

pub fn set_controllee_id(&mut self, id: Option<u32>) -> Result<(), VitaError>

Sets the controllee identifier. If None is passed, the field will be unset.

Errors

If this function is called while the controllee_uuid field is set, an error will be returned as these fields are mutually exclusive.

pub fn controller_id(&self) -> Option<u32>

Get the controller identifier.

pub fn set_controller_id(&mut self, id: Option<u32>) -> Result<(), VitaError>

Sets the controller identifier. If None is passed, the field will be unset.

Errors

If this function is called while the controller_uuid field is set, an error will be returned as these fields are mutually exclusive.

pub fn controllee_uuid(&self) -> Option<u128>

Get the controllee UUID.

pub fn set_controllee_uuid( &mut self, uuid: Option<u128>, ) -> Result<(), VitaError>

Sets the controllee UUID. If None is passed, the field will be unset.

Errors

If this function is called while the controllee_id field is set, an error will be returned as these fields are mutually exclusive.

pub fn controller_uuid(&self) -> Option<u128>

Get the controller UUID.

pub fn set_controller_uuid( &mut self, uuid: Option<u128>, ) -> Result<(), VitaError>

Sets the controller UUID. If None is passed, the field will be unset.

Errors

If this function is called while the controller_id field is set, an error will be returned as these fields are mutually exclusive.

pub fn payload(&self) -> &CommandPayload

Get a reference to the underlying command payload enumeration.

pub fn payload_mut(&mut self) -> &mut CommandPayload

Get a mutable reference to the underlying command payload enumeration.

pub fn size_words(&self) -> u16

Get the size of the command packet (in 32-bit words).

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl Default for Command

fn default() -> Self

Returns the “default value” for a type.

impl DekuReader<'_, (Endian, &PacketHeader)> for Command

fn from_reader_with_ctx<R: Read + Seek>( __deku_reader: &mut Reader<'_, R>, (endian, packet_header): (Endian, &PacketHeader), ) -> Result<Self, DekuError>

Construct type from reader implementing no_std_io::Read, with ctx.

impl DekuUpdate for Command

fn update(&mut self) -> Result<(), DekuError>

Apply updates

impl DekuWriter<(Endian, &PacketHeader)> for Command

fn to_writer<W: Write + Seek>( &self, __deku_writer: &mut Writer<W>, (endian, packet_header): (Endian, &PacketHeader), ) -> Result<(), DekuError>

Write type to bytes

impl<'de> Deserialize<'de> for Command

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Command

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

Formats the value using the given formatter.

impl Hash for Command

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Command

fn cmp(&self, other: &Command) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Command

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

fn partial_cmp(&self, other: &Command) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Command

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Payload> for Command

type Error = Payload

The type returned in the event of a conversion error.

fn try_from(value: Payload) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Command

impl StructuralPartialEq for Command