rust/spacepackets
5
1
Fork 0
Code Issues Pull Requests Projects Releases 27 Wiki Activity

doc tweaks
All checks were successful
Rust/spacepackets/pipeline/head This commit looks good
Details

Browse Source
This commit is contained in:
Robin Müller 2022-12-05 09:03:40 +01:00
parent e8571866e8
commit 0c77a04059
No known key found for this signature in database
GPG Key ID: 71B58F8A3CDFA9AC
3 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib.rs
View File

@ -478,10 +478,12 @@ impl SpHeader {
//noinspection RsTraitImplementation //noinspection RsTraitImplementation
delegate!(to self.packet_id { delegate!(to self.packet_id {
/// Returns [false] and fails if the APID exceeds [MAX_APID]
pub fn set_apid(&mut self, apid: u16) -> bool; pub fn set_apid(&mut self, apid: u16) -> bool;
}); });
delegate!(to self.psc { delegate!(to self.psc {
/// Returns [false] and fails if the sequence count exceeds [MAX_SEQ_COUNT]
pub fn set_seq_count(&mut self, seq_count: u16) -> bool; pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
}); });

8
src/tc.rs
View File

@ -208,9 +208,9 @@ impl PusTcSecondaryHeader {
/// This class models a PUS telecommand. It is the primary data structure to generate the raw byte /// This class models a PUS telecommand. It is the primary data structure to generate the raw byte
/// representation of a PUS telecommand or to deserialize from one from raw bytes. /// representation of a PUS telecommand or to deserialize from one from raw bytes.
/// ///
/// This class also derives the [serde::Serialize] and [serde::Deserialize] trait which allows /// This class also derives the [serde::Serialize] and [serde::Deserialize] trait if the
/// to send around TC packets in a raw byte format using a serde provider like /// [serde] feature is used, which allows to send around TC packets in a raw byte format using a
/// [postcard](https://docs.rs/postcard/latest/postcard/). /// serde provider like [postcard](https://docs.rs/postcard/latest/postcard/).
/// ///
/// There is no spare bytes support yet. /// There is no spare bytes support yet.
#[derive(PartialEq, Eq, Copy, Clone, Debug)] #[derive(PartialEq, Eq, Copy, Clone, Debug)]
@ -326,7 +326,7 @@ impl<'slice> PusTc<'slice> {
self.crc16 = Some(digest.finalize()) self.crc16 = Some(digest.finalize())
} }
/// This helper function calls both [PusTc.update_ccsds_data_len] and [PusTc.calc_own_crc16]. /// This helper function calls both [PusTc::update_ccsds_data_len] and [PusTc::calc_own_crc16].
pub fn update_packet_fields(&mut self) { pub fn update_packet_fields(&mut self) {
self.update_ccsds_data_len(); self.update_ccsds_data_len();
self.calc_own_crc16(); self.calc_own_crc16();

6
src/tm.rs
View File

@ -196,9 +196,9 @@ impl<'slice> TryFrom<zc::PusTmSecHeader<'slice>> for PusTmSecondaryHeader<'slice
/// structure to generate the raw byte representation of PUS telemetry or to /// structure to generate the raw byte representation of PUS telemetry or to
/// deserialize from one from raw bytes. /// deserialize from one from raw bytes.
/// ///
/// This class also derives the [serde::Serialize] and [serde::Deserialize] trait which allows /// This class also derives the [serde::Serialize] and [serde::Deserialize] trait if the [serde]
/// to send around TM packets in a raw byte format using a serde provider like /// feature is used which allows to send around TM packets in a raw byte format using a serde
/// [postcard](https://docs.rs/postcard/latest/postcard/). /// provider like [postcard](https://docs.rs/postcard/latest/postcard/).
/// ///
/// There is no spare bytes support yet. /// There is no spare bytes support yet.
#[derive(PartialEq, Eq, Debug, Copy, Clone)] #[derive(PartialEq, Eq, Debug, Copy, Clone)]