rust/sat-rs
rust/sat-rs
6
1
Fork 0
Code Issues 9 Pull Requests Projects Releases 23 Wiki Activity

doc fixes
All checks were successful
Rust/sat-rs/pipeline/pr-main This commit looks good
Details

Browse Source
This commit is contained in:
Robin Müller 2024-02-10 11:53:46 +01:00
parent 0af6b5283d
commit 30e2a354cb
Signed by: muellerr
GPG Key ID: A649FB78196E3849
2 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
satrs-core/src/pool.rs
View File

@ -252,7 +252,7 @@ pub trait PoolProvider {
} }
pub trait PoolProviderWithGuards: PoolProvider { pub trait PoolProviderWithGuards: PoolProvider {
/// This function behaves like [PoolProviderMemInPlace::read], but consumes the provided address /// This function behaves like [PoolProvider::read], but consumes the provided address
/// and returns a RAII conformant guard object. /// and returns a RAII conformant guard object.
/// ///
/// Unless the guard [PoolRwGuard::release] method is called, the data for the /// Unless the guard [PoolRwGuard::release] method is called, the data for the
@ -262,7 +262,7 @@ pub trait PoolProviderWithGuards: PoolProvider {
/// manual deletion is necessary when returning from a processing function prematurely. /// manual deletion is necessary when returning from a processing function prematurely.
fn read_with_guard(&mut self, addr: StoreAddr) -> PoolGuard<Self>; fn read_with_guard(&mut self, addr: StoreAddr) -> PoolGuard<Self>;
/// This function behaves like [PoolProviderMemInPlace::modify], but consumes the provided /// This function behaves like [PoolProvider::modify], but consumes the provided
/// address and returns a RAII conformant guard object. /// address and returns a RAII conformant guard object.
/// ///
/// Unless the guard [PoolRwGuard::release] method is called, the data for the /// Unless the guard [PoolRwGuard::release] method is called, the data for the

12
satrs-core/src/pus/scheduler.rs
View File

@ -376,7 +376,7 @@ pub mod alloc_mod {
/// This is the core data structure for scheduling PUS telecommands with [alloc] support. /// This is the core data structure for scheduling PUS telecommands with [alloc] support.
/// ///
/// It is assumed that the actual telecommand data is stored in a separate TC pool offering /// It is assumed that the actual telecommand data is stored in a separate TC pool offering
/// a [crate::pool::PoolProviderMemInPlace] API. This data structure just tracks the store /// a [crate::pool::PoolProvider] API. This data structure just tracks the store
/// addresses and their release times and offers a convenient API to insert and release /// addresses and their release times and offers a convenient API to insert and release
/// telecommands and perform other functionality specified by the ECSS standard in section 6.11. /// telecommands and perform other functionality specified by the ECSS standard in section 6.11.
/// The time is tracked as a [spacepackets::time::UnixTimestamp] but the only requirement to /// The time is tracked as a [spacepackets::time::UnixTimestamp] but the only requirement to
@ -695,10 +695,12 @@ pub mod alloc_mod {
self.release_telecommands_internal(releaser, tc_store, Some(tc_buf)) self.release_telecommands_internal(releaser, tc_store, Some(tc_buf))
} }
/// This functions is almost identical to [release_telecommands] but does not require /// This functions is almost identical to [Self::release_telecommands_with_buffer] but does
/// a user provided TC buffer because it will always use the [PoolProvider::read_as_vec] /// not require a user provided TC buffer because it will always use the
/// API to read the TC packets. However, this will also perform frequent allocations /// [PoolProvider::read_as_vec] API to read the TC packets.
/// for all telecommands being released. ///
/// However, this might also perform frequent allocations for all telecommands being
/// released.
pub fn release_telecommands<R: FnMut(bool, &TcInfo, &[u8]) -> bool>( pub fn release_telecommands<R: FnMut(bool, &TcInfo, &[u8]) -> bool>(
&mut self, &mut self,
releaser: R, releaser: R,