Struct PusTcReader 

pub struct PusTcReader<'raw_data> { /* private fields */ }

This class can be used to read a PUS TC telecommand from raw memory.

This class also derives the serde::Serialize and serde::Deserialize trait if the serde feature is used, which allows to send around TC packets in a raw byte format using a serde provider like postcard.

There is no spare bytes support yet.

Lifetimes

• 'raw_data - Lifetime of the provided raw slice.

Implementations

impl<'raw_data> PusTcReader<'raw_data>

pub fn new(slice: &'raw_data [u8]) -> Result<Self, PusError>

Create a PusTcReader instance from a raw slice. The given packet should have a a CRC-16-CCITT checksum which is also verified.

pub fn new_checksum_no_table(slice: &'raw_data [u8]) -> Result<Self, PusError>

Similar to PusTcReader::new, but uses a table-less CRC16 algorithm which can reduce binary size and memory usage.

pub fn new_no_checksum(slice: &'raw_data [u8]) -> Result<Self, PusError>

Read a PUS TC from a raw slice where no checksum is expected.

pub fn new_no_checksum_verification( slice: &'raw_data [u8], has_checksum: bool, ) -> Result<Self, PusError>

Create a new Self instance without verifying the checksum, even if the packet has one.

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

Application data slice.

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

Full raw data slice.

pub fn len_packed(&self) -> usize

Length of the packed data.

pub fn sp_header(&self) -> &SpHeader

Space packet header.

pub fn crc16(&self) -> Option<u16>

CRC16 checksum if present.

Trait Implementations

impl CcsdsPacket for PusTcReader<'_>

fn ccsds_version(&self) -> u3

CCSDS version field.

fn packet_id(&self) -> PacketId

CCSDS packet ID.

fn psc(&self) -> PacketSequenceControl

CCSDS packet sequence control.

fn data_len(&self) -> u16

Data length field.

fn packet_len(&self) -> usize

Total packet size based on the data length field

fn total_len(&self) -> usize

👎Deprecated since 0.16.0: use packet_len instead

Deprecated alias for Self::packet_len.

fn packet_id_raw(&self) -> u16

Retrieve 13 bit Packet Identification field. Can usually be retrieved with a bitwise AND of the first 2 bytes with 0x1FFF.

fn psc_raw(&self) -> u16

Retrieve Packet Sequence Count

fn packet_type(&self) -> PacketType

CCSDS packet type.

fn is_tm(&self) -> bool

Is this a telemetry packet?

fn is_tc(&self) -> bool

Is this a telecommand packet?

fn sec_header_flag(&self) -> bool

CCSDS secondary header flag. Returns true if a secondary header is present and false if it is not.

fn apid(&self) -> u11

CCSDS Application Process ID (APID).

fn seq_count(&self) -> u14

CCSDS sequence count.

fn sequence_flags(&self) -> SequenceFlags

CCSDS sequence flags.

impl<'raw_data> Clone for PusTcReader<'raw_data>

fn clone(&self) -> PusTcReader<'raw_data>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'raw_data> Debug for PusTcReader<'raw_data>

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

Formats the value using the given formatter.

impl<'de: 'raw_data, 'raw_data> Deserialize<'de> for PusTcReader<'raw_data>

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'raw_data> Format for PusTcReader<'raw_data>

where &'raw_data [u8]: Format, SpHeader: Format, PusTcSecondaryHeader: Format, Option<u16>: Format,

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl GenericPusTcSecondaryHeader for PusTcReader<'_>

fn pus_version(&self) -> Result<PusVersion, u4>

PUS version.

fn message_type_id(&self) -> MessageTypeId

Message type ID.

fn service_type_id(&self) -> u8

Service type ID.

fn message_subtype_id(&self) -> u8

Message subtype ID.

fn source_id(&self) -> u16

Source ID.

fn ack_flags(&self) -> AckFlags

Acknowledgement flags.

impl PartialEq<PusTcCreator<'_>> for PusTcReader<'_>

fn eq(&self, other: &PusTcCreator<'_>) -> 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 PartialEq<PusTcReader<'_>> for PusTcCreator<'_>

fn eq(&self, other: &PusTcReader<'_>) -> 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 PartialEq for PusTcReader<'_>

fn eq(&self, other: &Self) -> 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 PusPacket for PusTcReader<'_>

fn pus_version(&self) -> Result<PusVersion, u4>

PUS version.

fn message_type_id(&self) -> MessageTypeId

Message type ID.

fn service_type_id(&self) -> u8

Service type ID.

fn message_subtype_id(&self) -> u8

Message subtype ID.

fn has_checksum(&self) -> bool

The presence of the CRC-16-CCITT checksum is optional.

fn user_data(&self) -> &[u8]

User data field.

fn checksum(&self) -> Option<u16>

CRC-16-CCITT checksum.

impl<'raw_data> Serialize for PusTcReader<'raw_data>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'raw_data> Copy for PusTcReader<'raw_data>

impl<'raw_data> Eq for PusTcReader<'raw_data>

impl IsPusTelecommand for PusTcReader<'_>