Struct Command

#[repr(C)]
pub struct Command<T: Copy> {
    pub payload: T,
    /* private fields */
}

A cFS-flavor CCSDS command packet, as a Rust structure.

Fields

payload: T

The message’s payload. As messages are copied willy-nilly, T needs to be Copy.

Implementations

impl<T: Copy> Command<T>

pub fn new(msg_id: u32, function_code: u16, payload: T) -> Result<Self, ()>

If msg_id and function_code are a permissible message ID and a permissible command code (respectively), returns a new Command with the payload initialized to payload; otherwise returns an error.

pub fn new_default(msg_id: u32, function_code: u16) -> Result<Self, ()>

where T: Default,

Self::new, but using Default::default() as the payload.

pub fn as_bytes(&self) -> &[u8]

Returns a view of the Command as a sequence of bytes, ready for transmission.

pub unsafe fn from_bytes(bytes: &[u8]) -> Result<Self, ()>

Turns a sequence of bytes representing a message into a Command, assuming bytes is the correct length and the header bytes have sane values.

Safety

Using this function is only safe if the part of bytes at bytes 8..(8 + std::mem::size_of::<T>()) is byte-for-byte equal to a valid item of type T.

pub fn msg_id(&self) -> u32

Returns the message’s message ID.

pub fn function_code(&self) -> u16

Returns the message’s command code.

pub fn set_msg_id(&mut self, msg_id: u32) -> Result<(), ()>

If msg_id is a valid message ID, sets the message’s message ID to msg_id.

pub fn set_function_code(&mut self, function_code: u16) -> Result<(), ()>

If function_code is a valid command code, sets the message’s function code to function_code.

Trait Implementations

impl<T: Clone + Copy> Clone for Command<T>

fn clone(&self) -> Command<T>

Returns a copy of the value.

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

Performs copy-assignment from source.