Struct SpHeader

pub struct SpHeader {
    pub version: u8,
    pub packet_id: PacketId,
    pub psc: PacketSequenceCtrl,
    pub data_len: u16,
}

Space Packet Primary Header according to CCSDS 133.0-B-2.

Arguments

• version - CCSDS version field, occupies the first 3 bits of the raw header. Will generally be set to 0b000 in all constructors provided by this crate.
• packet_id - Packet Identifier, which can also be used as a start marker. Occupies the last 13 bits of the first two bytes of the raw header
• psc - Packet Sequence Control, occupies the third and fourth byte of the raw header
• data_len - Data length field occupies the fifth and the sixth byte of the raw header

Fields

version: u8

packet_id: PacketId

psc: PacketSequenceCtrl

data_len: u16

Implementations

impl SpHeader

pub const fn new( packet_id: PacketId, psc: PacketSequenceCtrl, data_len: u16, ) -> Self

pub const fn new_from_apid(apid: u16) -> Self

This constructor sets the sequence flag field to SequenceFlags::Unsegmented and the data length to 0.

This constructor will panic if the APID exceeds MAX_APID.

pub fn new_from_apid_checked(apid: u16) -> Option<Self>

Checked variant of Self::new_from_apid.

pub const fn new_from_fields( ptype: PacketType, sec_header: bool, apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16, ) -> Self

This constructor panics if the passed APID exceeds MAX_APID or the passed packet sequence count exceeds MAX_SEQ_COUNT.

The checked constructor variants can be used to avoid panics.

pub fn new_from_fields_checked( ptype: PacketType, sec_header: bool, apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16, ) -> Option<Self>

Create a new Space Packet Header instance which can be used to create generic Space Packets.

This will return None if the APID or sequence count argument exceed MAX_APID or MAX_SEQ_COUNT respectively. The version field is set to 0b000.

pub fn new_for_tm_checked( apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16, ) -> Option<Self>

Helper function for telemetry space packet headers. The packet type field will be set accordingly. The secondary header flag field is set to false.

pub fn new_for_tc_checked( apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16, ) -> Option<Self>

Helper function for telemetry space packet headers. The packet type field will be set accordingly. The secondary header flag field is set to false.

pub const fn new_for_tm( apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16, ) -> Self

This is an unchecked constructor which can panic on invalid input.

pub const fn new_for_tc( apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16, ) -> Self

This is an unchecked constructor which can panic on invalid input.

pub fn new_for_unseg_tm_checked( apid: u16, seq_count: u16, data_len: u16, ) -> Option<Self>

Variant of SpHeader::new_for_tm_checked which sets the sequence flag field to SequenceFlags::Unsegmented

pub fn new_for_unseg_tc_checked( apid: u16, seq_count: u16, data_len: u16, ) -> Option<Self>

Variant of SpHeader::new_for_tc_checked which sets the sequence flag field to SequenceFlags::Unsegmented

pub const fn new_for_unseg_tc(apid: u16, seq_count: u16, data_len: u16) -> Self

Variant of SpHeader::new_for_tc which sets the sequence flag field to SequenceFlags::Unsegmented.

This is an unchecked constructor which can panic on invalid input.

pub const fn new_for_unseg_tm(apid: u16, seq_count: u16, data_len: u16) -> Self

Variant of SpHeader::new_for_tm which sets the sequence flag field to SequenceFlags::Unsegmented.

This is an unchecked constructor which can panic on invalid input.

pub fn set_apid(&mut self, apid: u16) -> bool

Returns false and fails if the APID exceeds MAX_APID

pub fn set_seq_count(&mut self, seq_count: u16) -> bool

Returns false and fails if the sequence count exceeds MAX_SEQ_COUNT

pub fn set_seq_flags(&mut self, seq_flags: SequenceFlags)

pub fn set_sec_header_flag(&mut self)

pub fn clear_sec_header_flag(&mut self)

pub fn set_packet_type(&mut self, packet_type: PacketType)

pub fn from_be_bytes(buf: &[u8]) -> Result<(Self, &[u8]), ByteConversionError>

Create a struct from a raw slice where the fields have network endianness (big). This function also returns the remaining part of the passed slice starting past the read CCSDS header.

pub fn write_to_be_bytes<'a>( &self, buf: &'a mut [u8], ) -> Result<&'a mut [u8], ByteConversionError>

Write the header to a raw buffer using big endian format. This function returns the remaining part of the passed slice starting past the written CCSDS header.

pub fn to_vec(&self) -> Vec<u8>

Available on crate feature alloc only.

Create a vector containing the CCSDS header.

Trait Implementations

impl CcsdsPacket for SpHeader

fn ccsds_version(&self) -> u8

fn packet_id(&self) -> PacketId

fn psc(&self) -> PacketSequenceCtrl

fn data_len(&self) -> u16

Retrieve data length field

fn total_len(&self) -> usize

Retrieve the total packet size based on the data length field

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 ptype(&self) -> PacketType

Retrieve Packet Type (TM: 0, TC: 1).

fn is_tm(&self) -> bool

fn is_tc(&self) -> bool

fn sec_header_flag(&self) -> bool

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

fn apid(&self) -> u16

Retrieve Application Process ID.

fn seq_count(&self) -> u16

fn sequence_flags(&self) -> SequenceFlags

impl CcsdsPrimaryHeader for SpHeader

fn from_composite_fields( packet_id: PacketId, psc: PacketSequenceCtrl, data_len: u16, version: Option<u8>, ) -> Self

impl Clone for SpHeader

fn clone(&self) -> SpHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpHeader

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

Formats the value using the given formatter.

impl Default for SpHeader

fn default() -> Self

The default function sets the sequence flag field to SequenceFlags::Unsegmented and the data length to 0.

impl<'de> Deserialize<'de> for SpHeader

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Format for SpHeader

where PacketId: Format, PacketSequenceCtrl: Format,

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

Writes the defmt representation of self to fmt.

impl From<SpHeader> for SpHeader

fn from(other: SpHeader) -> Self

Converts to this type from the input type.

impl From<SpHeader> for SpHeader

fn from(other: SpHeader) -> Self

Converts to this type from the input type.

impl PartialEq for SpHeader

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SpHeader

impl Eq for SpHeader

impl StructuralPartialEq for SpHeader