Struct PacketId

pub struct PacketId {
    pub ptype: PacketType,
    pub sec_header_flag: bool,
    /* private fields */
}

Abstraction for the CCSDS Packet ID, which forms the last thirteen bits of the first two bytes in the CCSDS primary header.

Fields

ptype: PacketType

sec_header_flag: bool

Implementations

impl PacketId

pub const fn new_for_tc(sec_header: bool, apid: u16) -> Self

This constructor will panic if the passed APID exceeds MAX_APID. Use the checked constructor variants to avoid panics.

pub const fn new_for_tm(sec_header: bool, apid: u16) -> Self

This constructor will panic if the passed APID exceeds MAX_APID. Use the checked constructor variants to avoid panics.

pub fn new_for_tc_checked(sec_header: bool, apid: u16) -> Option<Self>

pub fn new_for_tm_checked(sec_header: bool, apid: u16) -> Option<Self>

pub const fn new(ptype: PacketType, sec_header: bool, apid: u16) -> Self

This constructor will panic if the passed APID exceeds MAX_APID. Use the checked variants to avoid panics.

pub fn new_checked( ptype: PacketType, sec_header_flag: bool, apid: u16, ) -> Option<PacketId>

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

Set a new Application Process ID (APID). If the passed number is invalid, the APID will not be set and false will be returned. The maximum allowed value for the 11-bit field is 2047

pub fn apid(&self) -> u16

pub fn raw(&self) -> u16

Trait Implementations

impl Clone for PacketId

fn clone(&self) -> PacketId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PacketId

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

Formats the value using the given formatter.

impl Default for PacketId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PacketId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Format for PacketId

where PacketType: Format,

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

Writes the defmt representation of self to fmt.

impl From<u16> for PacketId

fn from(raw_id: u16) -> Self

Converts to this type from the input type.

impl Hash for PacketId

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 PacketId

fn cmp(&self, other: &Self) -> 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 PacketId

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 PartialOrd for PacketId

fn partial_cmp(&self, other: &Self) -> 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 PacketId

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 PacketId

impl Eq for PacketId