Compare commits
93 Commits
Author | SHA1 | Date | |
---|---|---|---|
0e347b0e37 | |||
58dabb6f2f | |||
7fd65aa592 | |||
0024afc83e | |||
c48bd848d3 | |||
b8be9ae641 | |||
c2506dbba9 | |||
b842b9d11a | |||
374c034e92 | |||
791c7f6e02 | |||
8001938507 | |||
73ab7ff148 | |||
c59d01174f | |||
eb49bff0c9 | |||
af392d40d0 | |||
b78bfe2114 | |||
69a3b1d8f3 | |||
e7b3ba9575 | |||
c515535ccd | |||
95158a8cd2 | |||
8b1ccb0cd0 | |||
619b22e58f | |||
55222d92b3 | |||
8e1934e604 | |||
5f37978c56 | |||
97bbb14168 | |||
a65a98f43f | |||
e1a200e65b | |||
b55c7db3fc | |||
944bcf1320 | |||
8972dcbfc0 | |||
04b671fa6f | |||
533afc33fa | |||
50c56f6504 | |||
9e02e00d1a | |||
d8676ae711 | |||
9711159969 | |||
57adb619b3 | |||
fe52657d11 | |||
50b86939a1 | |||
179984f258 | |||
deb89362a4 | |||
4cd40f37ce | |||
bbd66a6a8b | |||
0115461bb5 | |||
ca90393d95 | |||
325e7d6ff3 | |||
228f198006 | |||
54f065ed74 | |||
4ef65279ea | |||
f0af16dc29 | |||
d05a1077e8 | |||
fc684a42a8 | |||
e9ddc316c8 | |||
4da417dfd2 | |||
cabb3a19ef | |||
5eef376351 | |||
538548b05e | |||
caaecdff0c | |||
3045a27d8c | |||
c7cf83d468 | |||
ef37a84edc | |||
c1b32bca21 | |||
d9525674c3 | |||
8b151d942d | |||
85a8eb3f4a | |||
fb71185b4a | |||
3e62d7d411 | |||
3faffd52fc | |||
7476fc8096 | |||
59c7ece126 | |||
6f5254bdbd | |||
bd1927c5c2 | |||
77862868d5 | |||
ea05a547ac | |||
0ab69b3ddc | |||
240f0bc267 | |||
00744a22fc | |||
c5aeeec19f | |||
d13cd28962 | |||
5641d9007e | |||
f39ea2f793 | |||
e4730d4b8f | |||
64ea7e609d | |||
ebaa6210a4 | |||
d14f532f62 | |||
6ea18d3715 | |||
6056342334 | |||
4e6dcc5afa | |||
200593bfb4 | |||
60bf876dd3 | |||
f47604346e | |||
0d0d7a256a |
115
.github/workflows/ci.yml
vendored
115
.github/workflows/ci.yml
vendored
|
@ -1,42 +1,39 @@
|
||||||
on: [push]
|
|
||||||
|
|
||||||
name: ci
|
name: ci
|
||||||
|
on: [push, pull_request]
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
check:
|
check:
|
||||||
name: Check
|
name: Check build
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest, macos-latest, windows-latest]
|
os: [ubuntu-latest, macos-latest, windows-latest]
|
||||||
runs-on: ${{ matrix.os }}
|
runs-on: ${{ matrix.os }}
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
- uses: actions-rs/toolchain@v1
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
with:
|
- run: cargo check --release
|
||||||
profile: minimal
|
|
||||||
toolchain: stable
|
|
||||||
- uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: check
|
|
||||||
args: --release
|
|
||||||
|
|
||||||
msrv:
|
test:
|
||||||
name: Check with MSRV
|
name: Run Tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
- uses: actions-rs/toolchain@v1
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
with:
|
- name: Install nextest
|
||||||
toolchain: 1.61.0
|
uses: taiki-e/install-action@nextest
|
||||||
override: true
|
- run: cargo nextest run --all-features
|
||||||
profile: minimal
|
- run: cargo test --doc
|
||||||
- uses: actions-rs/cargo@v1
|
|
||||||
with:
|
msrv:
|
||||||
command: check
|
name: Check MSRV
|
||||||
args: --release
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- uses: dtolnay/rust-toolchain@1.68.2
|
||||||
|
- run: cargo check --release
|
||||||
|
|
||||||
cross-check:
|
cross-check:
|
||||||
name: Check Cross
|
name: Check Cross-Compilation
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
strategy:
|
strategy:
|
||||||
matrix:
|
matrix:
|
||||||
|
@ -44,70 +41,32 @@ jobs:
|
||||||
- armv7-unknown-linux-gnueabihf
|
- armv7-unknown-linux-gnueabihf
|
||||||
- thumbv7em-none-eabihf
|
- thumbv7em-none-eabihf
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
- uses: actions-rs/toolchain@v1
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
with:
|
with:
|
||||||
profile: minimal
|
targets: "armv7-unknown-linux-gnueabihf, thumbv7em-none-eabihf"
|
||||||
toolchain: stable
|
- run: cargo check --release --target=${{matrix.target}} --no-default-features
|
||||||
target: ${{ matrix.target }}
|
|
||||||
override: true
|
|
||||||
- uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
use-cross: true
|
|
||||||
command: check
|
|
||||||
args: --release --target=${{ matrix.target }} --no-default-features
|
|
||||||
|
|
||||||
fmt:
|
fmt:
|
||||||
name: Rustfmt
|
name: Check formatting
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
- uses: actions-rs/toolchain@v1
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
with:
|
- run: cargo fmt --all -- --check
|
||||||
profile: minimal
|
|
||||||
toolchain: stable
|
|
||||||
override: true
|
|
||||||
- run: rustup component add rustfmt
|
|
||||||
- uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: fmt
|
|
||||||
args: --all -- --check
|
|
||||||
|
|
||||||
check-doc:
|
docs:
|
||||||
name: Check Documentation Build
|
name: Check Documentation Build
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
- uses: actions-rs/toolchain@v1
|
- uses: dtolnay/rust-toolchain@nightly
|
||||||
with:
|
- run: cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]'
|
||||||
toolchain: nightly
|
|
||||||
override: true
|
|
||||||
profile: minimal
|
|
||||||
- uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: doc
|
|
||||||
args: --all-features
|
|
||||||
|
|
||||||
clippy:
|
clippy:
|
||||||
name: Clippy
|
name: Clippy
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v2
|
- uses: actions/checkout@v4
|
||||||
- uses: actions-rs/toolchain@v1
|
- uses: dtolnay/rust-toolchain@stable
|
||||||
with:
|
- run: cargo clippy -- -D warnings
|
||||||
profile: minimal
|
|
||||||
toolchain: stable
|
|
||||||
- run: rustup component add clippy
|
|
||||||
- uses: actions-rs/cargo@v1
|
|
||||||
with:
|
|
||||||
command: clippy
|
|
||||||
args: -- -D warnings
|
|
||||||
|
|
||||||
ci:
|
|
||||||
if: ${{ success() }}
|
|
||||||
# all new jobs must be added to this list
|
|
||||||
needs: [check, fmt, clippy]
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: CI succeeded
|
|
||||||
run: exit 0
|
|
||||||
|
|
138
CHANGELOG.md
138
CHANGELOG.md
|
@ -8,6 +8,144 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
|
||||||
|
|
||||||
# [unreleased]
|
# [unreleased]
|
||||||
|
|
||||||
|
# [v0.11.2] 2024-05-19
|
||||||
|
|
||||||
|
- Bumped MSRV to 1.68.2
|
||||||
|
|
||||||
|
## Fixed
|
||||||
|
|
||||||
|
- Removed `defmt::Format` impl for `MetadataPduCreator` which seems to be problematic.
|
||||||
|
|
||||||
|
# [v0.11.1] 2024-04-22
|
||||||
|
|
||||||
|
## Fixed
|
||||||
|
|
||||||
|
- The default data length for for `SpHeader` constructors where the data field length is not
|
||||||
|
specified is now 0.
|
||||||
|
- The `SpHeader::new_from_fields` is public now.
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- `SpHeader::to_vec` method.
|
||||||
|
|
||||||
|
# [v0.11.0] 2024-04-16
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- Moved `CCSDS_HEADER_LEN` constant to the crate root.
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- Added `SpacePacketHeader` type alias for `SpHeader` type.
|
||||||
|
|
||||||
|
# [v0.11.0-rc.2] 2024-04-04
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- Renamed `PacketId` and `PacketSequenceCtrl` `new` method to `new_checked` and former
|
||||||
|
`new_const` method to `new`.
|
||||||
|
- Renamed `tc`, `tm`, `tc_unseg` and `tm_unseg` variants for `PacketId` and `SpHeader`
|
||||||
|
to `new_for_tc_checked`, `new_for_tm_checked`, `new_for_unseg_tc_checked` and
|
||||||
|
`new_for_unseg_tm_checked`.
|
||||||
|
- `PusTmCreator` and `PusTcCreator` now expect a regular instance of `SpHeader` instead of
|
||||||
|
a mutable reference.
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- `SpHeader::new_from_apid` and `SpHeader::new_from_apid_checked` constructor.
|
||||||
|
- `#[inline]` attribute for a lot of small functions.
|
||||||
|
|
||||||
|
# [v0.11.0-rc.1] 2024-04-03
|
||||||
|
|
||||||
|
Major API changes for the time API. If you are using the time API, it is strongly recommended
|
||||||
|
to check all the API changes in the **Changed** chapter.
|
||||||
|
|
||||||
|
## Fixed
|
||||||
|
|
||||||
|
- CUC timestamp was fixed to include leap second corrections because it is based on the TAI
|
||||||
|
time reference. The default CUC time object do not implement `CcsdsTimeProvider` anymore
|
||||||
|
because the trait methods require cached leap second information. This task is now performed
|
||||||
|
by the `cuc::CucTimeWithLeapSecs` which implements the trait.
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- `From<$EcssEnum$TY> from $TY` for the ECSS enum type definitions.
|
||||||
|
- Added basic support conversions to the `time` library. Introduce new `chrono` and `timelib`
|
||||||
|
feature gate.
|
||||||
|
- Added `CcsdsTimeProvider::timelib_date_time`.
|
||||||
|
- Optional support for `defmt` by adding optional `defmt::Format` derives for common types.
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- `PusTcCreator::new_simple` now expects a valid slice for the source data instead of an optional
|
||||||
|
slice. For telecommands without application data, `&[]` can be passed.
|
||||||
|
- `PusTmSecondaryHeader` constructors now expects a valid slice for the time stamp instead of an
|
||||||
|
optional slice.
|
||||||
|
- Renamed `CcsdsTimeProvider::date_time` to `CcsdsTimeProvider::chrono_date_time`
|
||||||
|
- Renamed `CcsdsTimeCodes` to `CcsdsTimeCode`
|
||||||
|
- Renamed `cds::TimeProvider` to `cds::CdsTime`
|
||||||
|
- Renamed `cuc::TimeProviderCcsdsEpoch` to `cuc::CucTime`
|
||||||
|
- `UnixTimestamp` renamed to `UnixTime`
|
||||||
|
- `UnixTime` seconds are now private and can be retrieved using the `secs` member method.
|
||||||
|
- `UnixTime::new` renamed to `UnixTime::new_checked`.
|
||||||
|
- `UnixTime::secs` renamed to `UnixTime::as_secs`.
|
||||||
|
- `UnixTime` now has a nanosecond subsecond precision. The `new` constructor now expects
|
||||||
|
nanoseconds as the second argument.
|
||||||
|
- Added new `UnixTime::new_subsec_millis` and `UnixTime::new_subsec_millis_checked` API
|
||||||
|
to still allow creating a timestamp with only millisecond subsecond resolution.
|
||||||
|
- `CcsdsTimeProvider` now has a new `subsec_nanos` method in addition to a default
|
||||||
|
implementation for the `subsec_millis` method.
|
||||||
|
- `CcsdsTimeProvider::date_time` renamed to `CcsdsTimeProvider::chrono_date_time`.
|
||||||
|
- Added `UnixTime::MIN`, `UnixTime::MAX` and `UnixTime::EPOCH`.
|
||||||
|
- Added `UnixTime::timelib_date_time`.
|
||||||
|
- Error handling for ECSS and time module is more granular now, with a new
|
||||||
|
`DateBeforeCcsdsEpochError` error and a `DateBeforeCcsdsEpoch` enum variant for both
|
||||||
|
`CdsError` and `CucError`.
|
||||||
|
- `PusTmCreator` now has two lifetimes: One for the raw source data buffer and one for the
|
||||||
|
raw timestamp.
|
||||||
|
- Time API `from_now*` API renamed to `now*`.
|
||||||
|
|
||||||
|
## Removed
|
||||||
|
|
||||||
|
- Legacy `PusTm` and `PusTc` objects.
|
||||||
|
|
||||||
|
# [v0.11.0-rc.0] 2024-03-04
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- `From<$TY>` for the `EcssEnum$TY` ECSS enum type definitions.
|
||||||
|
- `Sub` implementation for `UnixTimestamp` to calculate the duration between two timestamps.
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- `CcsdsTimeProvider` `subsecond_millis` function now returns `u16` instead of `Option<u16>`.
|
||||||
|
- `UnixTimestamp` `subsecond_millis` function now returns `u16` instead of `Option<u16>`.
|
||||||
|
|
||||||
|
# [v0.10.0] 2024-02-17
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- Added `value` and `to_vec` methods for the `UnsignedEnum` trait. The value is returned as
|
||||||
|
as `u64`. Renamed former `value` method on `GenericUnsignedByteField` to `value_typed`.
|
||||||
|
- Added `value_const` const function for `UnsignedByteField` type.
|
||||||
|
- Added `value_typed` const functions for `GenericUnsignedByteField` and `GenericEcssEnumWrapper`.
|
||||||
|
|
||||||
|
# [v0.9.0] 2024-02-07
|
||||||
|
|
||||||
|
## Added
|
||||||
|
|
||||||
|
- `CcsdsPacket`, `PusPacket` and `GenericPusTmSecondaryHeader` implementation for
|
||||||
|
`PusTmZeroCopyWriter`.
|
||||||
|
- Additional length checks for `PusTmZeroCopyWriter`.
|
||||||
|
|
||||||
|
## Changed
|
||||||
|
|
||||||
|
- `PusTmZeroCopyWriter`: Added additional timestamp length argument for `new` constructor.
|
||||||
|
|
||||||
|
## Fixed
|
||||||
|
|
||||||
|
- Typo: `PUC_TM_MIN_HEADER_LEN` -> `PUS_TM_MIN_HEADER_LEN`
|
||||||
|
|
||||||
# [v0.8.1] 2024-02-05
|
# [v0.8.1] 2024-02-05
|
||||||
|
|
||||||
## Fixed
|
## Fixed
|
||||||
|
|
24
Cargo.toml
24
Cargo.toml
|
@ -1,8 +1,8 @@
|
||||||
[package]
|
[package]
|
||||||
name = "spacepackets"
|
name = "spacepackets"
|
||||||
version = "0.8.1"
|
version = "0.11.2"
|
||||||
edition = "2021"
|
edition = "2021"
|
||||||
rust-version = "1.61"
|
rust-version = "1.68.2"
|
||||||
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
|
authors = ["Robin Mueller <muellerr@irs.uni-stuttgart.de>"]
|
||||||
description = "Generic implementations for various CCSDS and ECSS packet standards"
|
description = "Generic implementations for various CCSDS and ECSS packet standards"
|
||||||
homepage = "https://egit.irs.uni-stuttgart.de/rust/spacepackets"
|
homepage = "https://egit.irs.uni-stuttgart.de/rust/spacepackets"
|
||||||
|
@ -34,23 +34,37 @@ optional = true
|
||||||
default-features = false
|
default-features = false
|
||||||
features = ["derive"]
|
features = ["derive"]
|
||||||
|
|
||||||
|
[dependencies.time]
|
||||||
|
version = "0.3"
|
||||||
|
default-features = false
|
||||||
|
optional = true
|
||||||
|
|
||||||
[dependencies.chrono]
|
[dependencies.chrono]
|
||||||
version = "0.4"
|
version = "0.4"
|
||||||
default-features = false
|
default-features = false
|
||||||
|
optional = true
|
||||||
|
|
||||||
[dependencies.num-traits]
|
[dependencies.num-traits]
|
||||||
version = "0.2"
|
version = "0.2"
|
||||||
default-features = false
|
default-features = false
|
||||||
|
|
||||||
[dev-dependencies.postcard]
|
[dependencies.defmt]
|
||||||
version = "1"
|
version = "0.3"
|
||||||
|
optional = true
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
postcard = "1"
|
||||||
|
chrono = "0.4"
|
||||||
|
|
||||||
[features]
|
[features]
|
||||||
default = ["std"]
|
default = ["std"]
|
||||||
std = ["chrono/std", "chrono/clock", "alloc", "thiserror"]
|
std = ["chrono/std", "chrono/clock", "alloc", "thiserror"]
|
||||||
serde = ["dep:serde", "chrono/serde"]
|
serde = ["dep:serde", "chrono/serde"]
|
||||||
alloc = ["postcard/alloc", "chrono/alloc"]
|
alloc = ["postcard/alloc", "chrono/alloc"]
|
||||||
|
chrono = ["dep:chrono"]
|
||||||
|
timelib = ["dep:time"]
|
||||||
|
defmt = ["dep:defmt"]
|
||||||
|
|
||||||
[package.metadata.docs.rs]
|
[package.metadata.docs.rs]
|
||||||
all-features = true
|
all-features = true
|
||||||
rustdoc-args = ["--cfg", "doc_cfg", "--generate-link-to-definition"]
|
rustdoc-args = ["--cfg", "docs_rs", "--generate-link-to-definition"]
|
||||||
|
|
18
README.md
18
README.md
|
@ -29,10 +29,6 @@ Currently, this includes the following components:
|
||||||
|
|
||||||
`spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
`spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
||||||
|
|
||||||
It also offers optional support for [`serde`](https://serde.rs/). This allows serializing and
|
|
||||||
deserializing them with an appropriate `serde` provider like
|
|
||||||
[`postcard`](https://github.com/jamesmunns/postcard).
|
|
||||||
|
|
||||||
## Default features
|
## Default features
|
||||||
|
|
||||||
- [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library.
|
- [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library.
|
||||||
|
@ -43,6 +39,10 @@ deserializing them with an appropriate `serde` provider like
|
||||||
## Optional Features
|
## Optional Features
|
||||||
|
|
||||||
- [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and `Deserialize` `derive`s
|
- [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and `Deserialize` `derive`s
|
||||||
|
- [`chrono`](https://crates.io/crates/chrono): Add basic support for the `chrono` time library.
|
||||||
|
- [`timelib`](https://crates.io/crates/time): Add basic support for the `time` time library.
|
||||||
|
- [`defmt`](https://defmt.ferrous-systems.com/): Add support for the `defmt` by adding the
|
||||||
|
[`defmt::Format`](https://defmt.ferrous-systems.com/format) derive on many types.
|
||||||
|
|
||||||
# Examples
|
# Examples
|
||||||
|
|
||||||
|
@ -61,3 +61,13 @@ cargo install grcov --locked
|
||||||
|
|
||||||
After that, you can simply run `coverage.py` to test the project with coverage. You can optionally
|
After that, you can simply run `coverage.py` to test the project with coverage. You can optionally
|
||||||
supply the `--open` flag to open the coverage report in your webbrowser.
|
supply the `--open` flag to open the coverage report in your webbrowser.
|
||||||
|
|
||||||
|
# Miri
|
||||||
|
|
||||||
|
You can run the [`miri`](https://github.com/rust-lang/miri) tool on this library to check for
|
||||||
|
undefined behaviour (UB). This library does not use use any `unsafe` code blocks, but `miri` could
|
||||||
|
still catch UB from used libraries.
|
||||||
|
|
||||||
|
```sh
|
||||||
|
cargo +nightly miri nextest run --all-features
|
||||||
|
```
|
||||||
|
|
|
@ -15,7 +15,10 @@ RUN rustup install nightly && \
|
||||||
rustup target add thumbv7em-none-eabihf armv7-unknown-linux-gnueabihf && \
|
rustup target add thumbv7em-none-eabihf armv7-unknown-linux-gnueabihf && \
|
||||||
rustup component add rustfmt clippy llvm-tools-preview
|
rustup component add rustfmt clippy llvm-tools-preview
|
||||||
|
|
||||||
|
# Get grcov
|
||||||
RUN curl -sSL https://github.com/mozilla/grcov/releases/download/v0.8.19/grcov-x86_64-unknown-linux-gnu.tar.bz2 | tar -xj --directory /usr/local/bin
|
RUN curl -sSL https://github.com/mozilla/grcov/releases/download/v0.8.19/grcov-x86_64-unknown-linux-gnu.tar.bz2 | tar -xj --directory /usr/local/bin
|
||||||
|
# Get nextest
|
||||||
|
RUN curl -LsSf https://get.nexte.st/latest/linux | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin
|
||||||
|
|
||||||
# SSH stuff to allow deployment to doc server
|
# SSH stuff to allow deployment to doc server
|
||||||
RUN adduser --uid 114 jenkins
|
RUN adduser --uid 114 jenkins
|
||||||
|
|
3
automation/Jenkinsfile
vendored
3
automation/Jenkinsfile
vendored
|
@ -31,7 +31,8 @@ pipeline {
|
||||||
}
|
}
|
||||||
stage('Test') {
|
stage('Test') {
|
||||||
steps {
|
steps {
|
||||||
sh 'cargo test --all-features'
|
sh 'cargo nextest r --all-features'
|
||||||
|
sh 'cargo test --doc'
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
stage('Check with all features') {
|
stage('Check with all features') {
|
||||||
|
|
|
@ -4,11 +4,12 @@ Checklist for new releases
|
||||||
# Pre-Release
|
# Pre-Release
|
||||||
|
|
||||||
1. Make sure any new modules are documented sufficiently enough and check docs with
|
1. Make sure any new modules are documented sufficiently enough and check docs with
|
||||||
`cargo +nightly doc --all-features --config 'rustdocflags=["--cfg", "doc_cfg"]' --open`.
|
`cargo +nightly doc --all-features --config 'build.rustdocflags=["--cfg", "docs_rs"]' --open`.
|
||||||
2. Bump version specifier in `Cargo.toml`.
|
2. Bump version specifier in `Cargo.toml`.
|
||||||
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
|
3. Update `CHANGELOG.md`: Convert `unreleased` section into version section with date and add new
|
||||||
`unreleased` section.
|
`unreleased` section.
|
||||||
4. Run `cargo test --all-features`.
|
4. Run `cargo test --all-features` or `cargo nextest r --all-features` together with
|
||||||
|
`cargo test --doc`.
|
||||||
5. Run `cargo fmt` and `cargo clippy`. Check `cargo msrv` against MSRV in `Cargo.toml`.
|
5. Run `cargo fmt` and `cargo clippy`. Check `cargo msrv` against MSRV in `Cargo.toml`.
|
||||||
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
|
6. Wait for CI/CD results for EGit and Github. These also check cross-compilation for bare-metal
|
||||||
targets.
|
targets.
|
||||||
|
|
|
@ -20,6 +20,7 @@ pub const MIN_LV_LEN: usize = 1;
|
||||||
/// this will be the lifetime of that data reference.
|
/// this will be the lifetime of that data reference.
|
||||||
#[derive(Debug, Copy, Clone, Eq)]
|
#[derive(Debug, Copy, Clone, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct Lv<'data> {
|
pub struct Lv<'data> {
|
||||||
data: &'data [u8],
|
data: &'data [u8],
|
||||||
// If the LV was generated from a raw bytestream, this will contain the start of the
|
// If the LV was generated from a raw bytestream, this will contain the start of the
|
||||||
|
@ -61,6 +62,7 @@ pub(crate) fn generic_len_check_deserialization(
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'data> Lv<'data> {
|
impl<'data> Lv<'data> {
|
||||||
|
#[inline]
|
||||||
pub fn new(data: &[u8]) -> Result<Lv, TlvLvError> {
|
pub fn new(data: &[u8]) -> Result<Lv, TlvLvError> {
|
||||||
if data.len() > u8::MAX as usize {
|
if data.len() > u8::MAX as usize {
|
||||||
return Err(TlvLvError::DataTooLarge(data.len()));
|
return Err(TlvLvError::DataTooLarge(data.len()));
|
||||||
|
@ -72,6 +74,7 @@ impl<'data> Lv<'data> {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Creates a LV with an empty value field.
|
/// Creates a LV with an empty value field.
|
||||||
|
#[inline]
|
||||||
pub fn new_empty() -> Lv<'data> {
|
pub fn new_empty() -> Lv<'data> {
|
||||||
Lv {
|
Lv {
|
||||||
data: &[],
|
data: &[],
|
||||||
|
@ -81,6 +84,7 @@ impl<'data> Lv<'data> {
|
||||||
|
|
||||||
/// Helper function to build a string LV. This is especially useful for the file or directory
|
/// Helper function to build a string LV. This is especially useful for the file or directory
|
||||||
/// path LVs
|
/// path LVs
|
||||||
|
#[inline]
|
||||||
pub fn new_from_str(str_slice: &str) -> Result<Lv, TlvLvError> {
|
pub fn new_from_str(str_slice: &str) -> Result<Lv, TlvLvError> {
|
||||||
Self::new(str_slice.as_bytes())
|
Self::new(str_slice.as_bytes())
|
||||||
}
|
}
|
||||||
|
@ -88,38 +92,44 @@ impl<'data> Lv<'data> {
|
||||||
/// Helper function to build a string LV. This is especially useful for the file or directory
|
/// Helper function to build a string LV. This is especially useful for the file or directory
|
||||||
/// path LVs
|
/// path LVs
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "std")))]
|
#[inline]
|
||||||
pub fn new_from_string(string: &'data String) -> Result<Lv<'data>, TlvLvError> {
|
pub fn new_from_string(string: &'data String) -> Result<Lv<'data>, TlvLvError> {
|
||||||
Self::new(string.as_bytes())
|
Self::new(string.as_bytes())
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the length of the value part, not including the length byte.
|
/// Returns the length of the value part, not including the length byte.
|
||||||
|
#[inline]
|
||||||
pub fn len_value(&self) -> usize {
|
pub fn len_value(&self) -> usize {
|
||||||
self.data.len()
|
self.data.len()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the full raw length, including the length byte.
|
/// Returns the full raw length, including the length byte.
|
||||||
|
#[inline]
|
||||||
pub fn len_full(&self) -> usize {
|
pub fn len_full(&self) -> usize {
|
||||||
self.len_value() + 1
|
self.len_value() + 1
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Checks whether the value field is empty.
|
/// Checks whether the value field is empty.
|
||||||
|
#[inline]
|
||||||
pub fn is_empty(&self) -> bool {
|
pub fn is_empty(&self) -> bool {
|
||||||
self.data.len() == 0
|
self.data.len() == 0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn value(&self) -> &[u8] {
|
pub fn value(&self) -> &[u8] {
|
||||||
self.data
|
self.data
|
||||||
}
|
}
|
||||||
|
|
||||||
/// If the LV was generated from a raw bytestream using [Self::from_bytes], the raw start
|
/// If the LV was generated from a raw bytestream using [Self::from_bytes], the raw start
|
||||||
/// of the LV can be retrieved with this method.
|
/// of the LV can be retrieved with this method.
|
||||||
|
#[inline]
|
||||||
pub fn raw_data(&self) -> Option<&[u8]> {
|
pub fn raw_data(&self) -> Option<&[u8]> {
|
||||||
self.raw_data
|
self.raw_data
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Convenience function to extract the value as a [str]. This is useful if the LV is
|
/// Convenience function to extract the value as a [str]. This is useful if the LV is
|
||||||
/// known to contain a [str], for example being a file name.
|
/// known to contain a [str], for example being a file name.
|
||||||
|
#[inline]
|
||||||
pub fn value_as_str(&self) -> Option<Result<&'data str, Utf8Error>> {
|
pub fn value_as_str(&self) -> Option<Result<&'data str, Utf8Error>> {
|
||||||
if self.is_empty() {
|
if self.is_empty() {
|
||||||
return None;
|
return None;
|
||||||
|
@ -135,6 +145,7 @@ impl<'data> Lv<'data> {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Reads a LV from a raw buffer.
|
/// Reads a LV from a raw buffer.
|
||||||
|
#[inline]
|
||||||
pub fn from_bytes(buf: &'data [u8]) -> Result<Lv<'data>, ByteConversionError> {
|
pub fn from_bytes(buf: &'data [u8]) -> Result<Lv<'data>, ByteConversionError> {
|
||||||
generic_len_check_deserialization(buf, MIN_LV_LEN)?;
|
generic_len_check_deserialization(buf, MIN_LV_LEN)?;
|
||||||
Self::from_be_bytes_no_len_check(buf)
|
Self::from_be_bytes_no_len_check(buf)
|
||||||
|
@ -151,6 +162,7 @@ impl<'data> Lv<'data> {
|
||||||
MIN_LV_LEN + self.data.len()
|
MIN_LV_LEN + self.data.len()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub(crate) fn from_be_bytes_no_len_check(
|
pub(crate) fn from_be_bytes_no_len_check(
|
||||||
buf: &'data [u8],
|
buf: &'data [u8],
|
||||||
) -> Result<Lv<'data>, ByteConversionError> {
|
) -> Result<Lv<'data>, ByteConversionError> {
|
||||||
|
|
|
@ -18,6 +18,7 @@ pub const CFDP_VERSION_2: u8 = 0b001;
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum PduType {
|
pub enum PduType {
|
||||||
FileDirective = 0,
|
FileDirective = 0,
|
||||||
|
@ -26,6 +27,7 @@ pub enum PduType {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum Direction {
|
pub enum Direction {
|
||||||
TowardsReceiver = 0,
|
TowardsReceiver = 0,
|
||||||
|
@ -34,6 +36,7 @@ pub enum Direction {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum TransmissionMode {
|
pub enum TransmissionMode {
|
||||||
Acknowledged = 0,
|
Acknowledged = 0,
|
||||||
|
@ -42,6 +45,7 @@ pub enum TransmissionMode {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum CrcFlag {
|
pub enum CrcFlag {
|
||||||
NoCrc = 0,
|
NoCrc = 0,
|
||||||
|
@ -69,6 +73,7 @@ impl From<CrcFlag> for bool {
|
||||||
/// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
|
/// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum SegmentMetadataFlag {
|
pub enum SegmentMetadataFlag {
|
||||||
NotPresent = 0,
|
NotPresent = 0,
|
||||||
|
@ -78,6 +83,7 @@ pub enum SegmentMetadataFlag {
|
||||||
/// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
|
/// Always 0 and ignored for File Directive PDUs (CCSDS 727.0-B-5 P.75)
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum SegmentationControl {
|
pub enum SegmentationControl {
|
||||||
NoRecordBoundaryPreservation = 0,
|
NoRecordBoundaryPreservation = 0,
|
||||||
|
@ -86,6 +92,7 @@ pub enum SegmentationControl {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum FaultHandlerCode {
|
pub enum FaultHandlerCode {
|
||||||
NoticeOfCancellation = 0b0001,
|
NoticeOfCancellation = 0b0001,
|
||||||
|
@ -96,6 +103,7 @@ pub enum FaultHandlerCode {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum ConditionCode {
|
pub enum ConditionCode {
|
||||||
/// This is not an error condition for which a faulty handler override can be specified
|
/// This is not an error condition for which a faulty handler override can be specified
|
||||||
|
@ -118,6 +126,7 @@ pub enum ConditionCode {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum LargeFileFlag {
|
pub enum LargeFileFlag {
|
||||||
/// 32 bit maximum file size and FSS size
|
/// 32 bit maximum file size and FSS size
|
||||||
|
@ -129,6 +138,7 @@ pub enum LargeFileFlag {
|
||||||
/// Transaction status for the ACK PDU field according to chapter 5.2.4 of the CFDP standard.
|
/// Transaction status for the ACK PDU field according to chapter 5.2.4 of the CFDP standard.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum TransactionStatus {
|
pub enum TransactionStatus {
|
||||||
/// Transaction is not currently active and the CFDP implementation does not retain a
|
/// Transaction is not currently active and the CFDP implementation does not retain a
|
||||||
|
@ -146,6 +156,7 @@ pub enum TransactionStatus {
|
||||||
/// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/)
|
/// [SANA Checksum Types registry](https://sanaregistry.org/r/checksum_identifiers/)
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum ChecksumType {
|
pub enum ChecksumType {
|
||||||
/// Modular legacy checksum
|
/// Modular legacy checksum
|
||||||
|
@ -167,6 +178,7 @@ pub const NULL_CHECKSUM_U32: [u8; 4] = [0; 4];
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum TlvLvError {
|
pub enum TlvLvError {
|
||||||
DataTooLarge(usize),
|
DataTooLarge(usize),
|
||||||
ByteConversion(ByteConversionError),
|
ByteConversion(ByteConversionError),
|
||||||
|
|
|
@ -15,6 +15,7 @@ use serde::{Deserialize, Serialize};
|
||||||
/// For more information, refer to CFDP chapter 5.2.4.
|
/// For more information, refer to CFDP chapter 5.2.4.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct AckPdu {
|
pub struct AckPdu {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
directive_code_of_acked_pdu: FileDirectiveType,
|
directive_code_of_acked_pdu: FileDirectiveType,
|
||||||
|
|
|
@ -15,6 +15,7 @@ use super::{CfdpPdu, WritablePduPacket};
|
||||||
/// For more information, refer to CFDP chapter 5.2.2.
|
/// For more information, refer to CFDP chapter 5.2.2.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct EofPdu {
|
pub struct EofPdu {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
condition_code: ConditionCode,
|
condition_code: ConditionCode,
|
||||||
|
|
|
@ -14,6 +14,7 @@ use super::{CfdpPdu, WritablePduPacket};
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum DeliveryCode {
|
pub enum DeliveryCode {
|
||||||
Complete = 0,
|
Complete = 0,
|
||||||
|
@ -22,6 +23,7 @@ pub enum DeliveryCode {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum FileStatus {
|
pub enum FileStatus {
|
||||||
DiscardDeliberately = 0b00,
|
DiscardDeliberately = 0b00,
|
||||||
|
@ -34,6 +36,7 @@ pub enum FileStatus {
|
||||||
///
|
///
|
||||||
/// For more information, refer to CFDP chapter 5.2.3.
|
/// For more information, refer to CFDP chapter 5.2.3.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct FinishedPduCreator<'fs_responses> {
|
pub struct FinishedPduCreator<'fs_responses> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
condition_code: ConditionCode,
|
condition_code: ConditionCode,
|
||||||
|
@ -219,6 +222,7 @@ impl<'buf> Iterator for FilestoreResponseIterator<'buf> {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct FinishedPduReader<'buf> {
|
pub struct FinishedPduReader<'buf> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
condition_code: ConditionCode,
|
condition_code: ConditionCode,
|
||||||
|
@ -581,7 +585,7 @@ mod tests {
|
||||||
assert_eq!(finished_pdu_vec.len(), 12);
|
assert_eq!(finished_pdu_vec.len(), 12);
|
||||||
assert_eq!(finished_pdu_vec[9], TlvType::EntityId.into());
|
assert_eq!(finished_pdu_vec[9], TlvType::EntityId.into());
|
||||||
assert_eq!(finished_pdu_vec[10], 1);
|
assert_eq!(finished_pdu_vec[10], 1);
|
||||||
assert_eq!(finished_pdu_vec[11], TEST_DEST_ID.value());
|
assert_eq!(finished_pdu_vec[11], TEST_DEST_ID.value_typed());
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
finished_pdu.fault_location().unwrap().entity_id(),
|
finished_pdu.fault_location().unwrap().entity_id(),
|
||||||
&TEST_DEST_ID.into()
|
&TEST_DEST_ID.into()
|
||||||
|
|
|
@ -15,6 +15,7 @@ use super::{CfdpPdu, WritablePduPacket};
|
||||||
|
|
||||||
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct MetadataGenericParams {
|
pub struct MetadataGenericParams {
|
||||||
pub closure_requested: bool,
|
pub closure_requested: bool,
|
||||||
pub checksum_type: ChecksumType,
|
pub checksum_type: ChecksumType,
|
||||||
|
@ -241,6 +242,7 @@ impl<'opts> Iterator for OptionsIter<'opts> {
|
||||||
/// involved.
|
/// involved.
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct MetadataPduReader<'buf> {
|
pub struct MetadataPduReader<'buf> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
metadata_params: MetadataGenericParams,
|
metadata_params: MetadataGenericParams,
|
||||||
|
|
|
@ -18,6 +18,7 @@ pub mod nak;
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum FileDirectiveType {
|
pub enum FileDirectiveType {
|
||||||
EofPdu = 0x04,
|
EofPdu = 0x04,
|
||||||
|
@ -149,12 +150,14 @@ impl Error for PduError {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<ByteConversionError> for PduError {
|
impl From<ByteConversionError> for PduError {
|
||||||
|
#[inline]
|
||||||
fn from(value: ByteConversionError) -> Self {
|
fn from(value: ByteConversionError) -> Self {
|
||||||
Self::ByteConversion(value)
|
Self::ByteConversion(value)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<TlvLvError> for PduError {
|
impl From<TlvLvError> for PduError {
|
||||||
|
#[inline]
|
||||||
fn from(e: TlvLvError) -> Self {
|
fn from(e: TlvLvError) -> Self {
|
||||||
Self::TlvLvError(e)
|
Self::TlvLvError(e)
|
||||||
}
|
}
|
||||||
|
@ -178,33 +181,42 @@ pub trait WritablePduPacket {
|
||||||
pub trait CfdpPdu {
|
pub trait CfdpPdu {
|
||||||
fn pdu_header(&self) -> &PduHeader;
|
fn pdu_header(&self) -> &PduHeader;
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn source_id(&self) -> UnsignedByteField {
|
fn source_id(&self) -> UnsignedByteField {
|
||||||
self.pdu_header().common_pdu_conf().source_entity_id
|
self.pdu_header().common_pdu_conf().source_entity_id
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn dest_id(&self) -> UnsignedByteField {
|
fn dest_id(&self) -> UnsignedByteField {
|
||||||
self.pdu_header().common_pdu_conf().dest_entity_id
|
self.pdu_header().common_pdu_conf().dest_entity_id
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn transaction_seq_num(&self) -> UnsignedByteField {
|
fn transaction_seq_num(&self) -> UnsignedByteField {
|
||||||
self.pdu_header().common_pdu_conf().transaction_seq_num
|
self.pdu_header().common_pdu_conf().transaction_seq_num
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn transmission_mode(&self) -> TransmissionMode {
|
fn transmission_mode(&self) -> TransmissionMode {
|
||||||
self.pdu_header().common_pdu_conf().trans_mode
|
self.pdu_header().common_pdu_conf().trans_mode
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn direction(&self) -> Direction {
|
fn direction(&self) -> Direction {
|
||||||
self.pdu_header().common_pdu_conf().direction
|
self.pdu_header().common_pdu_conf().direction
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn crc_flag(&self) -> CrcFlag {
|
fn crc_flag(&self) -> CrcFlag {
|
||||||
self.pdu_header().common_pdu_conf().crc_flag
|
self.pdu_header().common_pdu_conf().crc_flag
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn file_flag(&self) -> LargeFileFlag {
|
fn file_flag(&self) -> LargeFileFlag {
|
||||||
self.pdu_header().common_pdu_conf().file_flag
|
self.pdu_header().common_pdu_conf().file_flag
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn pdu_type(&self) -> PduType {
|
fn pdu_type(&self) -> PduType {
|
||||||
self.pdu_header().pdu_type()
|
self.pdu_header().pdu_type()
|
||||||
}
|
}
|
||||||
|
@ -220,6 +232,7 @@ pub trait CfdpPdu {
|
||||||
/// same.
|
/// same.
|
||||||
#[derive(Debug, Copy, Clone, Eq)]
|
#[derive(Debug, Copy, Clone, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct CommonPduConfig {
|
pub struct CommonPduConfig {
|
||||||
source_entity_id: UnsignedByteField,
|
source_entity_id: UnsignedByteField,
|
||||||
dest_entity_id: UnsignedByteField,
|
dest_entity_id: UnsignedByteField,
|
||||||
|
@ -232,6 +245,7 @@ pub struct CommonPduConfig {
|
||||||
|
|
||||||
// TODO: Builder pattern might be applicable here..
|
// TODO: Builder pattern might be applicable here..
|
||||||
impl CommonPduConfig {
|
impl CommonPduConfig {
|
||||||
|
#[inline]
|
||||||
pub fn new(
|
pub fn new(
|
||||||
source_id: impl Into<UnsignedByteField>,
|
source_id: impl Into<UnsignedByteField>,
|
||||||
dest_id: impl Into<UnsignedByteField>,
|
dest_id: impl Into<UnsignedByteField>,
|
||||||
|
@ -263,6 +277,7 @@ impl CommonPduConfig {
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn new_with_byte_fields(
|
pub fn new_with_byte_fields(
|
||||||
source_id: impl Into<UnsignedByteField>,
|
source_id: impl Into<UnsignedByteField>,
|
||||||
dest_id: impl Into<UnsignedByteField>,
|
dest_id: impl Into<UnsignedByteField>,
|
||||||
|
@ -279,10 +294,12 @@ impl CommonPduConfig {
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn source_id(&self) -> UnsignedByteField {
|
pub fn source_id(&self) -> UnsignedByteField {
|
||||||
self.source_entity_id
|
self.source_entity_id
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn source_dest_id_check(
|
fn source_dest_id_check(
|
||||||
source_id: impl Into<UnsignedByteField>,
|
source_id: impl Into<UnsignedByteField>,
|
||||||
dest_id: impl Into<UnsignedByteField>,
|
dest_id: impl Into<UnsignedByteField>,
|
||||||
|
@ -305,6 +322,7 @@ impl CommonPduConfig {
|
||||||
Ok((source_id, dest_id))
|
Ok((source_id, dest_id))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn set_source_and_dest_id(
|
pub fn set_source_and_dest_id(
|
||||||
&mut self,
|
&mut self,
|
||||||
source_id: impl Into<UnsignedByteField>,
|
source_id: impl Into<UnsignedByteField>,
|
||||||
|
@ -316,6 +334,7 @@ impl CommonPduConfig {
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn dest_id(&self) -> UnsignedByteField {
|
pub fn dest_id(&self) -> UnsignedByteField {
|
||||||
self.dest_entity_id
|
self.dest_entity_id
|
||||||
}
|
}
|
||||||
|
@ -324,6 +343,7 @@ impl CommonPduConfig {
|
||||||
impl Default for CommonPduConfig {
|
impl Default for CommonPduConfig {
|
||||||
/// The defaults for the source ID, destination ID and the transaction sequence number is the
|
/// The defaults for the source ID, destination ID and the transaction sequence number is the
|
||||||
/// [UnsignedByteFieldU8] with an intitial value of 0
|
/// [UnsignedByteFieldU8] with an intitial value of 0
|
||||||
|
#[inline]
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
// The new function can not fail for these input parameters.
|
// The new function can not fail for these input parameters.
|
||||||
Self::new(
|
Self::new(
|
||||||
|
@ -340,6 +360,7 @@ impl Default for CommonPduConfig {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PartialEq for CommonPduConfig {
|
impl PartialEq for CommonPduConfig {
|
||||||
|
#[inline]
|
||||||
fn eq(&self, other: &Self) -> bool {
|
fn eq(&self, other: &Self) -> bool {
|
||||||
self.source_entity_id.value() == other.source_entity_id.value()
|
self.source_entity_id.value() == other.source_entity_id.value()
|
||||||
&& self.dest_entity_id.value() == other.dest_entity_id.value()
|
&& self.dest_entity_id.value() == other.dest_entity_id.value()
|
||||||
|
@ -358,6 +379,7 @@ pub const FIXED_HEADER_LEN: usize = 4;
|
||||||
/// For detailed information, refer to chapter 5.1 of the CFDP standard.
|
/// For detailed information, refer to chapter 5.1 of the CFDP standard.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct PduHeader {
|
pub struct PduHeader {
|
||||||
pdu_type: PduType,
|
pdu_type: PduType,
|
||||||
pdu_conf: CommonPduConfig,
|
pdu_conf: CommonPduConfig,
|
||||||
|
@ -367,6 +389,7 @@ pub struct PduHeader {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PduHeader {
|
impl PduHeader {
|
||||||
|
#[inline]
|
||||||
pub fn new_for_file_data(
|
pub fn new_for_file_data(
|
||||||
pdu_conf: CommonPduConfig,
|
pdu_conf: CommonPduConfig,
|
||||||
pdu_datafield_len: u16,
|
pdu_datafield_len: u16,
|
||||||
|
@ -382,6 +405,7 @@ impl PduHeader {
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn new_for_file_data_default(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
pub fn new_for_file_data_default(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
||||||
Self::new_generic(
|
Self::new_generic(
|
||||||
PduType::FileData,
|
PduType::FileData,
|
||||||
|
@ -391,6 +415,7 @@ impl PduHeader {
|
||||||
SegmentationControl::NoRecordBoundaryPreservation,
|
SegmentationControl::NoRecordBoundaryPreservation,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
#[inline]
|
||||||
pub fn new_no_file_data(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
pub fn new_no_file_data(pdu_conf: CommonPduConfig, pdu_datafield_len: u16) -> Self {
|
||||||
Self::new_generic(
|
Self::new_generic(
|
||||||
PduType::FileDirective,
|
PduType::FileDirective,
|
||||||
|
@ -401,6 +426,7 @@ impl PduHeader {
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn new_generic(
|
pub fn new_generic(
|
||||||
pdu_type: PduType,
|
pdu_type: PduType,
|
||||||
pdu_conf: CommonPduConfig,
|
pdu_conf: CommonPduConfig,
|
||||||
|
@ -418,6 +444,7 @@ impl PduHeader {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns only the length of the PDU header when written to a raw buffer.
|
/// Returns only the length of the PDU header when written to a raw buffer.
|
||||||
|
#[inline]
|
||||||
pub fn header_len(&self) -> usize {
|
pub fn header_len(&self) -> usize {
|
||||||
FIXED_HEADER_LEN
|
FIXED_HEADER_LEN
|
||||||
+ self.pdu_conf.source_entity_id.size()
|
+ self.pdu_conf.source_entity_id.size()
|
||||||
|
@ -425,12 +452,14 @@ impl PduHeader {
|
||||||
+ self.pdu_conf.dest_entity_id.size()
|
+ self.pdu_conf.dest_entity_id.size()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn pdu_datafield_len(&self) -> usize {
|
pub fn pdu_datafield_len(&self) -> usize {
|
||||||
self.pdu_datafield_len.into()
|
self.pdu_datafield_len.into()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the full length of the PDU when written to a raw buffer, which is the header length
|
/// Returns the full length of the PDU when written to a raw buffer, which is the header length
|
||||||
/// plus the PDU datafield length.
|
/// plus the PDU datafield length.
|
||||||
|
#[inline]
|
||||||
pub fn pdu_len(&self) -> usize {
|
pub fn pdu_len(&self) -> usize {
|
||||||
self.header_len() + self.pdu_datafield_len as usize
|
self.header_len() + self.pdu_datafield_len as usize
|
||||||
}
|
}
|
||||||
|
@ -603,10 +632,13 @@ impl PduHeader {
|
||||||
current_idx,
|
current_idx,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn pdu_type(&self) -> PduType {
|
pub fn pdu_type(&self) -> PduType {
|
||||||
self.pdu_type
|
self.pdu_type
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn common_pdu_conf(&self) -> &CommonPduConfig {
|
pub fn common_pdu_conf(&self) -> &CommonPduConfig {
|
||||||
&self.pdu_conf
|
&self.pdu_conf
|
||||||
}
|
}
|
||||||
|
@ -614,6 +646,8 @@ impl PduHeader {
|
||||||
pub fn seg_metadata_flag(&self) -> SegmentMetadataFlag {
|
pub fn seg_metadata_flag(&self) -> SegmentMetadataFlag {
|
||||||
self.seg_metadata_flag
|
self.seg_metadata_flag
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn seg_ctrl(&self) -> SegmentationControl {
|
pub fn seg_ctrl(&self) -> SegmentationControl {
|
||||||
self.seg_ctrl
|
self.seg_ctrl
|
||||||
}
|
}
|
||||||
|
|
|
@ -12,6 +12,7 @@ use super::{
|
||||||
/// Helper type to encapsulate both normal file size segment requests and large file size segment
|
/// Helper type to encapsulate both normal file size segment requests and large file size segment
|
||||||
/// requests.
|
/// requests.
|
||||||
#[derive(Debug, PartialEq, Eq, Clone)]
|
#[derive(Debug, PartialEq, Eq, Clone)]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum SegmentRequests<'a> {
|
pub enum SegmentRequests<'a> {
|
||||||
U32Pairs(&'a [(u32, u32)]),
|
U32Pairs(&'a [(u32, u32)]),
|
||||||
U64Pairs(&'a [(u64, u64)]),
|
U64Pairs(&'a [(u64, u64)]),
|
||||||
|
@ -31,6 +32,7 @@ impl SegmentRequests<'_> {
|
||||||
/// It exposes a specialized API which simplifies to generate these NAK PDUs with the
|
/// It exposes a specialized API which simplifies to generate these NAK PDUs with the
|
||||||
/// format according to CFDP chapter 5.2.6.
|
/// format according to CFDP chapter 5.2.6.
|
||||||
#[derive(Debug, Clone, PartialEq, Eq)]
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct NakPduCreator<'seg_reqs> {
|
pub struct NakPduCreator<'seg_reqs> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
start_of_scope: u64,
|
start_of_scope: u64,
|
||||||
|
@ -353,6 +355,7 @@ impl<T: SegReqFromBytes> SegmentRequestIter<'_, T> {
|
||||||
///
|
///
|
||||||
/// The NAK format is expected to be conforming to CFDP chapter 5.2.6.
|
/// The NAK format is expected to be conforming to CFDP chapter 5.2.6.
|
||||||
#[derive(Debug, PartialEq, Eq)]
|
#[derive(Debug, PartialEq, Eq)]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct NakPduReader<'seg_reqs> {
|
pub struct NakPduReader<'seg_reqs> {
|
||||||
pdu_header: PduHeader,
|
pdu_header: PduHeader,
|
||||||
start_of_scope: u64,
|
start_of_scope: u64,
|
||||||
|
|
|
@ -52,6 +52,7 @@ pub trait WritableTlv {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum TlvType {
|
pub enum TlvType {
|
||||||
FilestoreRequest = 0x00,
|
FilestoreRequest = 0x00,
|
||||||
|
@ -64,6 +65,7 @@ pub enum TlvType {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum TlvTypeField {
|
pub enum TlvTypeField {
|
||||||
Standard(TlvType),
|
Standard(TlvType),
|
||||||
Custom(u8),
|
Custom(u8),
|
||||||
|
@ -71,6 +73,7 @@ pub enum TlvTypeField {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq, TryFromPrimitive, IntoPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum FilestoreActionCode {
|
pub enum FilestoreActionCode {
|
||||||
CreateFile = 0b0000,
|
CreateFile = 0b0000,
|
||||||
|
@ -118,6 +121,7 @@ impl From<TlvTypeField> for u8 {
|
||||||
/// this will be the lifetime of that data reference.
|
/// this will be the lifetime of that data reference.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct Tlv<'data> {
|
pub struct Tlv<'data> {
|
||||||
tlv_type_field: TlvTypeField,
|
tlv_type_field: TlvTypeField,
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
#[cfg_attr(feature = "serde", serde(borrow))]
|
||||||
|
@ -224,6 +228,7 @@ pub(crate) fn verify_tlv_type(raw_type: u8, expected_tlv_type: TlvType) -> Resul
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct EntityIdTlv {
|
pub struct EntityIdTlv {
|
||||||
entity_id: UnsignedByteField,
|
entity_id: UnsignedByteField,
|
||||||
}
|
}
|
||||||
|
@ -348,6 +353,7 @@ pub fn fs_request_has_second_filename(action_code: FilestoreActionCode) -> bool
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
struct FilestoreTlvBase<'first_name, 'second_name> {
|
struct FilestoreTlvBase<'first_name, 'second_name> {
|
||||||
pub action_code: FilestoreActionCode,
|
pub action_code: FilestoreActionCode,
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
#[cfg_attr(feature = "serde", serde(borrow))]
|
||||||
|
@ -561,6 +567,7 @@ impl GenericTlv for FilestoreRequestTlv<'_, '_> {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct FilestoreResponseTlv<'first_name, 'second_name, 'fs_msg> {
|
pub struct FilestoreResponseTlv<'first_name, 'second_name, 'fs_msg> {
|
||||||
#[cfg_attr(feature = "serde", serde(borrow))]
|
#[cfg_attr(feature = "serde", serde(borrow))]
|
||||||
base: FilestoreTlvBase<'first_name, 'second_name>,
|
base: FilestoreTlvBase<'first_name, 'second_name>,
|
||||||
|
|
|
@ -5,6 +5,7 @@ use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
|
#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
pub enum Subservice {
|
pub enum Subservice {
|
||||||
// Regular HK
|
// Regular HK
|
||||||
|
|
133
src/ecss/mod.rs
133
src/ecss/mod.rs
|
@ -1,8 +1,8 @@
|
||||||
//! Common definitions and helpers required to create PUS TMTC packets according to
|
//! Common definitions and helpers required to create PUS TMTC packets according to
|
||||||
//! [ECSS-E-ST-70-41C](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/)
|
//! [ECSS-E-ST-70-41C](https://ecss.nl/standard/ecss-e-st-70-41c-space-engineering-telemetry-and-telecommand-packet-utilization-15-april-2016/)
|
||||||
//!
|
//!
|
||||||
//! You can find the PUS telecommand definitions in the [tc] module and ithe PUS telemetry definitions
|
//! You can find the PUS telecommand types in the [tc] module and the the PUS telemetry
|
||||||
//! inside the [tm] module.
|
//! types inside the [tm] module.
|
||||||
use crate::{ByteConversionError, CcsdsPacket, CRC_CCITT_FALSE};
|
use crate::{ByteConversionError, CcsdsPacket, CRC_CCITT_FALSE};
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
use alloc::vec::Vec;
|
use alloc::vec::Vec;
|
||||||
|
@ -22,7 +22,6 @@ pub mod tm;
|
||||||
pub mod verification;
|
pub mod verification;
|
||||||
|
|
||||||
pub type CrcType = u16;
|
pub type CrcType = u16;
|
||||||
pub const CCSDS_HEADER_LEN: usize = size_of::<crate::zc::SpHeader>();
|
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
|
#[derive(Debug, Copy, Clone, Eq, PartialEq, IntoPrimitive, TryFromPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
@ -74,6 +73,7 @@ pub enum PusServiceId {
|
||||||
/// All PUS versions. Only PUS C is supported by this library.
|
/// All PUS versions. Only PUS C is supported by this library.
|
||||||
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[non_exhaustive]
|
#[non_exhaustive]
|
||||||
pub enum PusVersion {
|
pub enum PusVersion {
|
||||||
EsaPus = 0,
|
EsaPus = 0,
|
||||||
|
@ -150,6 +150,7 @@ pub enum PfcReal {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum PusError {
|
pub enum PusError {
|
||||||
VersionNotSupported(PusVersion),
|
VersionNotSupported(PusVersion),
|
||||||
ChecksumFailure(u16),
|
ChecksumFailure(u16),
|
||||||
|
@ -205,13 +206,12 @@ pub trait PusPacket: CcsdsPacket {
|
||||||
fn crc16(&self) -> Option<u16>;
|
fn crc16(&self) -> Option<u16>;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn crc_from_raw_data(raw_data: &[u8]) -> Result<u16, PusError> {
|
pub(crate) fn crc_from_raw_data(raw_data: &[u8]) -> Result<u16, ByteConversionError> {
|
||||||
if raw_data.len() < 2 {
|
if raw_data.len() < 2 {
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
return Err(ByteConversionError::FromSliceTooSmall {
|
||||||
found: raw_data.len(),
|
found: raw_data.len(),
|
||||||
expected: 2,
|
expected: 2,
|
||||||
}
|
});
|
||||||
.into());
|
|
||||||
}
|
}
|
||||||
Ok(u16::from_be_bytes(
|
Ok(u16::from_be_bytes(
|
||||||
raw_data[raw_data.len() - 2..raw_data.len()]
|
raw_data[raw_data.len() - 2..raw_data.len()]
|
||||||
|
@ -226,35 +226,16 @@ pub(crate) fn calc_pus_crc16(bytes: &[u8]) -> u16 {
|
||||||
digest.finalize()
|
digest.finalize()
|
||||||
}
|
}
|
||||||
|
|
||||||
pub(crate) fn crc_procedure(
|
|
||||||
calc_on_serialization: bool,
|
|
||||||
cached_crc16: &Option<u16>,
|
|
||||||
start_idx: usize,
|
|
||||||
curr_idx: usize,
|
|
||||||
slice: &[u8],
|
|
||||||
) -> Result<u16, PusError> {
|
|
||||||
let crc16;
|
|
||||||
if calc_on_serialization {
|
|
||||||
crc16 = calc_pus_crc16(&slice[start_idx..curr_idx])
|
|
||||||
} else if cached_crc16.is_none() {
|
|
||||||
return Err(PusError::CrcCalculationMissing);
|
|
||||||
} else {
|
|
||||||
crc16 = cached_crc16.unwrap();
|
|
||||||
}
|
|
||||||
Ok(crc16)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub(crate) fn user_data_from_raw(
|
pub(crate) fn user_data_from_raw(
|
||||||
current_idx: usize,
|
current_idx: usize,
|
||||||
total_len: usize,
|
total_len: usize,
|
||||||
slice: &[u8],
|
slice: &[u8],
|
||||||
) -> Result<&[u8], PusError> {
|
) -> Result<&[u8], ByteConversionError> {
|
||||||
match current_idx {
|
match current_idx {
|
||||||
_ if current_idx > total_len - 2 => Err(ByteConversionError::FromSliceTooSmall {
|
_ if current_idx > total_len - 2 => Err(ByteConversionError::FromSliceTooSmall {
|
||||||
found: total_len - 2,
|
found: total_len - 2,
|
||||||
expected: current_idx,
|
expected: current_idx,
|
||||||
}
|
}),
|
||||||
.into()),
|
|
||||||
_ => Ok(&slice[current_idx..total_len - 2]),
|
_ => Ok(&slice[current_idx..total_len - 2]),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -264,7 +245,7 @@ pub(crate) fn verify_crc16_ccitt_false_from_raw_to_pus_error(
|
||||||
crc16: u16,
|
crc16: u16,
|
||||||
) -> Result<(), PusError> {
|
) -> Result<(), PusError> {
|
||||||
verify_crc16_ccitt_false_from_raw(raw_data)
|
verify_crc16_ccitt_false_from_raw(raw_data)
|
||||||
.then(|| ())
|
.then_some(())
|
||||||
.ok_or(PusError::ChecksumFailure(crc16))
|
.ok_or(PusError::ChecksumFailure(crc16))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -280,9 +261,13 @@ pub(crate) fn verify_crc16_ccitt_false_from_raw(raw_data: &[u8]) -> bool {
|
||||||
macro_rules! ccsds_impl {
|
macro_rules! ccsds_impl {
|
||||||
() => {
|
() => {
|
||||||
delegate!(to self.sp_header {
|
delegate!(to self.sp_header {
|
||||||
|
#[inline]
|
||||||
fn ccsds_version(&self) -> u8;
|
fn ccsds_version(&self) -> u8;
|
||||||
|
#[inline]
|
||||||
fn packet_id(&self) -> crate::PacketId;
|
fn packet_id(&self) -> crate::PacketId;
|
||||||
|
#[inline]
|
||||||
fn psc(&self) -> crate::PacketSequenceCtrl;
|
fn psc(&self) -> crate::PacketSequenceCtrl;
|
||||||
|
#[inline]
|
||||||
fn data_len(&self) -> u16;
|
fn data_len(&self) -> u16;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -291,8 +276,11 @@ macro_rules! ccsds_impl {
|
||||||
macro_rules! sp_header_impls {
|
macro_rules! sp_header_impls {
|
||||||
() => {
|
() => {
|
||||||
delegate!(to self.sp_header {
|
delegate!(to self.sp_header {
|
||||||
|
#[inline]
|
||||||
pub fn set_apid(&mut self, apid: u16) -> bool;
|
pub fn set_apid(&mut self, apid: u16) -> bool;
|
||||||
|
#[inline]
|
||||||
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
||||||
|
#[inline]
|
||||||
pub fn set_seq_flags(&mut self, seq_flag: SequenceFlags);
|
pub fn set_seq_flags(&mut self, seq_flag: SequenceFlags);
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -315,15 +303,19 @@ pub trait EcssEnumerationExt: EcssEnumeration + Debug + Copy + Clone + PartialEq
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
|
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
pub struct GenericEcssEnumWrapper<TYPE: Copy> {
|
pub struct GenericEcssEnumWrapper<TYPE: Copy + Into<u64>> {
|
||||||
field: GenericUnsignedByteField<TYPE>,
|
field: GenericUnsignedByteField<TYPE>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<TYPE: Copy> GenericEcssEnumWrapper<TYPE> {
|
impl<TYPE: Copy + Into<u64>> GenericEcssEnumWrapper<TYPE> {
|
||||||
pub const fn ptc() -> PacketTypeCodes {
|
pub const fn ptc() -> PacketTypeCodes {
|
||||||
PacketTypeCodes::Enumerated
|
PacketTypeCodes::Enumerated
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub const fn value_typed(&self) -> TYPE {
|
||||||
|
self.field.value_typed()
|
||||||
|
}
|
||||||
|
|
||||||
pub fn new(val: TYPE) -> Self {
|
pub fn new(val: TYPE) -> Self {
|
||||||
Self {
|
Self {
|
||||||
field: GenericUnsignedByteField::new(val),
|
field: GenericUnsignedByteField::new(val),
|
||||||
|
@ -331,7 +323,7 @@ impl<TYPE: Copy> GenericEcssEnumWrapper<TYPE> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<TYPE: Copy + ToBeBytes> UnsignedEnum for GenericEcssEnumWrapper<TYPE> {
|
impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericEcssEnumWrapper<TYPE> {
|
||||||
fn size(&self) -> usize {
|
fn size(&self) -> usize {
|
||||||
(self.pfc() / 8) as usize
|
(self.pfc() / 8) as usize
|
||||||
}
|
}
|
||||||
|
@ -339,23 +331,51 @@ impl<TYPE: Copy + ToBeBytes> UnsignedEnum for GenericEcssEnumWrapper<TYPE> {
|
||||||
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
|
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
|
||||||
self.field.write_to_be_bytes(buf)
|
self.field.write_to_be_bytes(buf)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn value(&self) -> u64 {
|
||||||
|
self.field.value()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<TYPE: Copy + ToBeBytes> EcssEnumeration for GenericEcssEnumWrapper<TYPE> {
|
impl<TYPE: Copy + ToBeBytes + Into<u64>> EcssEnumeration for GenericEcssEnumWrapper<TYPE> {
|
||||||
fn pfc(&self) -> u8 {
|
fn pfc(&self) -> u8 {
|
||||||
size_of::<TYPE>() as u8 * 8_u8
|
size_of::<TYPE>() as u8 * 8_u8
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<TYPE: Debug + Copy + Clone + PartialEq + Eq + ToBeBytes> EcssEnumerationExt
|
impl<TYPE: Debug + Copy + Clone + PartialEq + Eq + ToBeBytes + Into<u64>> EcssEnumerationExt
|
||||||
for GenericEcssEnumWrapper<TYPE>
|
for GenericEcssEnumWrapper<TYPE>
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
pub type EcssEnumU8 = GenericEcssEnumWrapper<u8>;
|
impl<T: Copy + Into<u64>> From<T> for GenericEcssEnumWrapper<T> {
|
||||||
pub type EcssEnumU16 = GenericEcssEnumWrapper<u16>;
|
fn from(value: T) -> Self {
|
||||||
pub type EcssEnumU32 = GenericEcssEnumWrapper<u32>;
|
Self::new(value)
|
||||||
pub type EcssEnumU64 = GenericEcssEnumWrapper<u64>;
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! generic_ecss_enum_typedefs_and_from_impls {
|
||||||
|
($($ty:ty => $Enum:ident),*) => {
|
||||||
|
$(
|
||||||
|
pub type $Enum = GenericEcssEnumWrapper<$ty>;
|
||||||
|
|
||||||
|
impl From<$Enum> for $ty {
|
||||||
|
fn from(value: $Enum) -> Self {
|
||||||
|
value.value_typed()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)*
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Generates EcssEnum<$TY> type definitions as well as a From<$TY> for EcssEnum<$TY>
|
||||||
|
// implementation.
|
||||||
|
generic_ecss_enum_typedefs_and_from_impls! {
|
||||||
|
u8 => EcssEnumU8,
|
||||||
|
u16 => EcssEnumU16,
|
||||||
|
u32 => EcssEnumU32,
|
||||||
|
u64 => EcssEnumU64
|
||||||
|
}
|
||||||
|
|
||||||
/// Generic trait for PUS packet abstractions which can written to a raw slice as their raw
|
/// Generic trait for PUS packet abstractions which can written to a raw slice as their raw
|
||||||
/// byte representation. This is especially useful for generic abstractions which depend only
|
/// byte representation. This is especially useful for generic abstractions which depend only
|
||||||
|
@ -396,6 +416,12 @@ mod tests {
|
||||||
.write_to_be_bytes(&mut buf[1..2])
|
.write_to_be_bytes(&mut buf[1..2])
|
||||||
.expect("To byte conversion of u8 failed");
|
.expect("To byte conversion of u8 failed");
|
||||||
assert_eq!(buf[1], 1);
|
assert_eq!(buf[1], 1);
|
||||||
|
assert_eq!(my_enum.value(), 1);
|
||||||
|
assert_eq!(my_enum.value_typed(), 1);
|
||||||
|
let enum_as_u8: u8 = my_enum.into();
|
||||||
|
assert_eq!(enum_as_u8, 1);
|
||||||
|
let vec = my_enum.to_vec();
|
||||||
|
assert_eq!(vec, buf[1..2]);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -409,6 +435,12 @@ mod tests {
|
||||||
assert_eq!(my_enum.pfc(), 16);
|
assert_eq!(my_enum.pfc(), 16);
|
||||||
assert_eq!(buf[1], 0x1f);
|
assert_eq!(buf[1], 0x1f);
|
||||||
assert_eq!(buf[2], 0x2f);
|
assert_eq!(buf[2], 0x2f);
|
||||||
|
assert_eq!(my_enum.value(), 0x1f2f);
|
||||||
|
assert_eq!(my_enum.value_typed(), 0x1f2f);
|
||||||
|
let enum_as_raw: u16 = my_enum.into();
|
||||||
|
assert_eq!(enum_as_raw, 0x1f2f);
|
||||||
|
let vec = my_enum.to_vec();
|
||||||
|
assert_eq!(vec, buf[1..3]);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -440,6 +472,12 @@ mod tests {
|
||||||
assert_eq!(buf[2], 0x2f);
|
assert_eq!(buf[2], 0x2f);
|
||||||
assert_eq!(buf[3], 0x3f);
|
assert_eq!(buf[3], 0x3f);
|
||||||
assert_eq!(buf[4], 0x4f);
|
assert_eq!(buf[4], 0x4f);
|
||||||
|
assert_eq!(my_enum.value(), 0x1f2f3f4f);
|
||||||
|
assert_eq!(my_enum.value_typed(), 0x1f2f3f4f);
|
||||||
|
let enum_as_raw: u32 = my_enum.into();
|
||||||
|
assert_eq!(enum_as_raw, 0x1f2f3f4f);
|
||||||
|
let vec = my_enum.to_vec();
|
||||||
|
assert_eq!(vec, buf[1..5]);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -460,6 +498,27 @@ mod tests {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_enum_u64() {
|
||||||
|
let mut buf = [0; 8];
|
||||||
|
let my_enum = EcssEnumU64::new(0x1f2f3f4f5f);
|
||||||
|
my_enum
|
||||||
|
.write_to_be_bytes(&mut buf)
|
||||||
|
.expect("To byte conversion of u64 failed");
|
||||||
|
assert_eq!(buf[3], 0x1f);
|
||||||
|
assert_eq!(buf[4], 0x2f);
|
||||||
|
assert_eq!(buf[5], 0x3f);
|
||||||
|
assert_eq!(buf[6], 0x4f);
|
||||||
|
assert_eq!(buf[7], 0x5f);
|
||||||
|
assert_eq!(my_enum.value(), 0x1f2f3f4f5f);
|
||||||
|
assert_eq!(my_enum.value_typed(), 0x1f2f3f4f5f);
|
||||||
|
let enum_as_raw: u64 = my_enum.into();
|
||||||
|
assert_eq!(enum_as_raw, 0x1f2f3f4f5f);
|
||||||
|
assert_eq!(u64::from_be_bytes(buf), 0x1f2f3f4f5f);
|
||||||
|
let vec = my_enum.to_vec();
|
||||||
|
assert_eq!(vec, buf);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_pus_error_display() {
|
fn test_pus_error_display() {
|
||||||
let unsupport_version = PusError::VersionNotSupported(super::PusVersion::EsaPus);
|
let unsupport_version = PusError::VersionNotSupported(super::PusVersion::EsaPus);
|
||||||
|
|
|
@ -54,6 +54,7 @@ pub enum SchedStatus {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<bool> for SchedStatus {
|
impl From<bool> for SchedStatus {
|
||||||
|
#[inline]
|
||||||
fn from(value: bool) -> Self {
|
fn from(value: bool) -> Self {
|
||||||
if value {
|
if value {
|
||||||
SchedStatus::Enabled
|
SchedStatus::Enabled
|
||||||
|
|
462
src/ecss/tc.rs
462
src/ecss/tc.rs
|
@ -9,9 +9,11 @@
|
||||||
//! use spacepackets::ecss::tc::{PusTcCreator, PusTcReader, PusTcSecondaryHeader};
|
//! use spacepackets::ecss::tc::{PusTcCreator, PusTcReader, PusTcSecondaryHeader};
|
||||||
//!
|
//!
|
||||||
//! // Create a ping telecommand with no user application data
|
//! // Create a ping telecommand with no user application data
|
||||||
//! let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
//! let pus_tc = PusTcCreator::new_no_app_data(
|
||||||
//! let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
//! SpHeader::new_from_apid(0x02),
|
||||||
//! let pus_tc = PusTcCreator::new_no_app_data(&mut sph, tc_header, true);
|
//! PusTcSecondaryHeader::new_simple(17, 1),
|
||||||
|
//! true
|
||||||
|
//! );
|
||||||
//! println!("{:?}", pus_tc);
|
//! println!("{:?}", pus_tc);
|
||||||
//! assert_eq!(pus_tc.service(), 17);
|
//! assert_eq!(pus_tc.service(), 17);
|
||||||
//! assert_eq!(pus_tc.subservice(), 1);
|
//! assert_eq!(pus_tc.subservice(), 1);
|
||||||
|
@ -48,8 +50,6 @@ use zerocopy::AsBytes;
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
use alloc::vec::Vec;
|
use alloc::vec::Vec;
|
||||||
|
|
||||||
pub use legacy_tc::*;
|
|
||||||
|
|
||||||
/// PUS C secondary header length is fixed
|
/// PUS C secondary header length is fixed
|
||||||
pub const PUC_TC_SECONDARY_HEADER_LEN: usize = size_of::<zc::PusTcSecondaryHeader>();
|
pub const PUC_TC_SECONDARY_HEADER_LEN: usize = size_of::<zc::PusTcSecondaryHeader>();
|
||||||
pub const PUS_TC_MIN_LEN_WITHOUT_APP_DATA: usize =
|
pub const PUS_TC_MIN_LEN_WITHOUT_APP_DATA: usize =
|
||||||
|
@ -61,6 +61,7 @@ pub trait IsPusTelecommand {}
|
||||||
|
|
||||||
#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
|
#[derive(Debug, Eq, PartialEq, Copy, Clone, IntoPrimitive, TryFromPrimitive)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[repr(u8)]
|
#[repr(u8)]
|
||||||
enum AckOpts {
|
enum AckOpts {
|
||||||
Acceptance = 0b1000,
|
Acceptance = 0b1000,
|
||||||
|
@ -112,22 +113,27 @@ pub mod zc {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
||||||
|
#[inline]
|
||||||
fn pus_version(&self) -> PusVersion {
|
fn pus_version(&self) -> PusVersion {
|
||||||
PusVersion::try_from(self.version_ack >> 4 & 0b1111).unwrap_or(PusVersion::Invalid)
|
PusVersion::try_from(self.version_ack >> 4 & 0b1111).unwrap_or(PusVersion::Invalid)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn ack_flags(&self) -> u8 {
|
fn ack_flags(&self) -> u8 {
|
||||||
self.version_ack & 0b1111
|
self.version_ack & 0b1111
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn service(&self) -> u8 {
|
fn service(&self) -> u8 {
|
||||||
self.service
|
self.service
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn subservice(&self) -> u8 {
|
fn subservice(&self) -> u8 {
|
||||||
self.subservice
|
self.subservice
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn source_id(&self) -> u16 {
|
fn source_id(&self) -> u16 {
|
||||||
self.source_id.get()
|
self.source_id.get()
|
||||||
}
|
}
|
||||||
|
@ -146,6 +152,7 @@ pub mod zc {
|
||||||
|
|
||||||
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct PusTcSecondaryHeader {
|
pub struct PusTcSecondaryHeader {
|
||||||
pub service: u8,
|
pub service: u8,
|
||||||
pub subservice: u8,
|
pub subservice: u8,
|
||||||
|
@ -155,22 +162,27 @@ pub struct PusTcSecondaryHeader {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
impl GenericPusTcSecondaryHeader for PusTcSecondaryHeader {
|
||||||
|
#[inline]
|
||||||
fn pus_version(&self) -> PusVersion {
|
fn pus_version(&self) -> PusVersion {
|
||||||
self.version
|
self.version
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn ack_flags(&self) -> u8 {
|
fn ack_flags(&self) -> u8 {
|
||||||
self.ack
|
self.ack
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn service(&self) -> u8 {
|
fn service(&self) -> u8 {
|
||||||
self.service
|
self.service
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn subservice(&self) -> u8 {
|
fn subservice(&self) -> u8 {
|
||||||
self.subservice
|
self.subservice
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn source_id(&self) -> u16 {
|
fn source_id(&self) -> u16 {
|
||||||
self.source_id
|
self.source_id
|
||||||
}
|
}
|
||||||
|
@ -191,6 +203,7 @@ impl TryFrom<zc::PusTcSecondaryHeader> for PusTcSecondaryHeader {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PusTcSecondaryHeader {
|
impl PusTcSecondaryHeader {
|
||||||
|
#[inline]
|
||||||
pub fn new_simple(service: u8, subservice: u8) -> Self {
|
pub fn new_simple(service: u8, subservice: u8) -> Self {
|
||||||
PusTcSecondaryHeader {
|
PusTcSecondaryHeader {
|
||||||
service,
|
service,
|
||||||
|
@ -201,6 +214,7 @@ impl PusTcSecondaryHeader {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn new(service: u8, subservice: u8, ack: u8, source_id: u16) -> Self {
|
pub fn new(service: u8, subservice: u8, ack: u8, source_id: u16) -> Self {
|
||||||
PusTcSecondaryHeader {
|
PusTcSecondaryHeader {
|
||||||
service,
|
service,
|
||||||
|
@ -212,333 +226,6 @@ impl PusTcSecondaryHeader {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub mod legacy_tc {
|
|
||||||
use crate::ecss::tc::{
|
|
||||||
zc, GenericPusTcSecondaryHeader, IsPusTelecommand, PusTcSecondaryHeader, ACK_ALL,
|
|
||||||
PUC_TC_SECONDARY_HEADER_LEN, PUS_TC_MIN_LEN_WITHOUT_APP_DATA,
|
|
||||||
};
|
|
||||||
use crate::ecss::{
|
|
||||||
ccsds_impl, crc_from_raw_data, crc_procedure, sp_header_impls,
|
|
||||||
verify_crc16_ccitt_false_from_raw_to_pus_error, PusError, PusPacket, WritablePusPacket,
|
|
||||||
CCSDS_HEADER_LEN,
|
|
||||||
};
|
|
||||||
use crate::ecss::{user_data_from_raw, PusVersion};
|
|
||||||
use crate::SequenceFlags;
|
|
||||||
use crate::{ByteConversionError, CcsdsPacket, PacketType, SpHeader, CRC_CCITT_FALSE};
|
|
||||||
use core::mem::size_of;
|
|
||||||
use delegate::delegate;
|
|
||||||
use zerocopy::AsBytes;
|
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
use alloc::vec::Vec;
|
|
||||||
|
|
||||||
#[cfg(feature = "serde")]
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
|
|
||||||
/// This class models the PUS C telecommand packet. It is the primary data structure to generate the
|
|
||||||
/// raw byte representation of a PUS telecommand or to deserialize from one from raw bytes.
|
|
||||||
///
|
|
||||||
/// 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](https://docs.rs/postcard/latest/postcard/).
|
|
||||||
///
|
|
||||||
/// There is no spare bytes support yet.
|
|
||||||
///
|
|
||||||
/// # Lifetimes
|
|
||||||
///
|
|
||||||
/// * `'raw_data` - If the TC is not constructed from a raw slice, this will be the life time of
|
|
||||||
/// a buffer where the user provided application data will be serialized into. If it
|
|
||||||
/// is, this is the lifetime of the raw byte slice it is constructed from.
|
|
||||||
#[derive(Eq, Copy, Clone, Debug)]
|
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
|
||||||
pub struct PusTc<'raw_data> {
|
|
||||||
sp_header: SpHeader,
|
|
||||||
pub sec_header: PusTcSecondaryHeader,
|
|
||||||
/// If this is set to false, a manual call to [PusTc::calc_own_crc16] or
|
|
||||||
/// [PusTc::update_packet_fields] is necessary for the serialized or cached CRC16 to be valid.
|
|
||||||
pub calc_crc_on_serialization: bool,
|
|
||||||
#[cfg_attr(feature = "serde", serde(skip))]
|
|
||||||
raw_data: Option<&'raw_data [u8]>,
|
|
||||||
app_data: &'raw_data [u8],
|
|
||||||
crc16: Option<u16>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<'raw_data> PusTc<'raw_data> {
|
|
||||||
/// Generates a new struct instance.
|
|
||||||
///
|
|
||||||
/// # Arguments
|
|
||||||
///
|
|
||||||
/// * `sp_header` - Space packet header information. The correct packet type will be set
|
|
||||||
/// automatically
|
|
||||||
/// * `sec_header` - Information contained in the data field header, including the service
|
|
||||||
/// and subservice type
|
|
||||||
/// * `app_data` - Custom application data
|
|
||||||
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
|
||||||
/// field. If this is not set to true, [PusTc::update_ccsds_data_len] can be called to set
|
|
||||||
/// the correct value to this field manually
|
|
||||||
#[deprecated(
|
|
||||||
since = "0.7.0",
|
|
||||||
note = "Use specialized PusTcCreator or PusTcReader classes instead"
|
|
||||||
)]
|
|
||||||
pub fn new(
|
|
||||||
sp_header: &mut SpHeader,
|
|
||||||
sec_header: PusTcSecondaryHeader,
|
|
||||||
app_data: Option<&'raw_data [u8]>,
|
|
||||||
set_ccsds_len: bool,
|
|
||||||
) -> Self {
|
|
||||||
sp_header.set_packet_type(PacketType::Tc);
|
|
||||||
sp_header.set_sec_header_flag();
|
|
||||||
let mut pus_tc = Self {
|
|
||||||
sp_header: *sp_header,
|
|
||||||
raw_data: None,
|
|
||||||
app_data: app_data.unwrap_or(&[]),
|
|
||||||
sec_header,
|
|
||||||
calc_crc_on_serialization: true,
|
|
||||||
crc16: None,
|
|
||||||
};
|
|
||||||
if set_ccsds_len {
|
|
||||||
pus_tc.update_ccsds_data_len();
|
|
||||||
}
|
|
||||||
pus_tc
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Simplified version of the [PusTc::new] function which allows to only specify service and
|
|
||||||
/// subservice instead of the full PUS TC secondary header.
|
|
||||||
#[deprecated(
|
|
||||||
since = "0.7.0",
|
|
||||||
note = "Use specialized PusTcCreator or PusTcReader classes instead"
|
|
||||||
)]
|
|
||||||
pub fn new_simple(
|
|
||||||
sph: &mut SpHeader,
|
|
||||||
service: u8,
|
|
||||||
subservice: u8,
|
|
||||||
app_data: Option<&'raw_data [u8]>,
|
|
||||||
set_ccsds_len: bool,
|
|
||||||
) -> Self {
|
|
||||||
#[allow(deprecated)]
|
|
||||||
Self::new(
|
|
||||||
sph,
|
|
||||||
PusTcSecondaryHeader::new(service, subservice, ACK_ALL, 0),
|
|
||||||
app_data,
|
|
||||||
set_ccsds_len,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn sp_header(&self) -> &SpHeader {
|
|
||||||
&self.sp_header
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_ack_field(&mut self, ack: u8) -> bool {
|
|
||||||
if ack > 0b1111 {
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
self.sec_header.ack = ack & 0b1111;
|
|
||||||
true
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn set_source_id(&mut self, source_id: u16) {
|
|
||||||
self.sec_header.source_id = source_id;
|
|
||||||
}
|
|
||||||
|
|
||||||
sp_header_impls!();
|
|
||||||
|
|
||||||
/// Calculate the CCSDS space packet data length field and sets it
|
|
||||||
/// This is called automatically if the `set_ccsds_len` argument in the [PusTc::new] call was
|
|
||||||
/// used.
|
|
||||||
/// If this was not done or the application data is set or changed after construction,
|
|
||||||
/// this function needs to be called to ensure that the data length field of the CCSDS header
|
|
||||||
/// is set correctly.
|
|
||||||
pub fn update_ccsds_data_len(&mut self) {
|
|
||||||
self.sp_header.data_len =
|
|
||||||
self.len_written() as u16 - size_of::<crate::zc::SpHeader>() as u16 - 1;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This function should be called before the TC packet is serialized if
|
|
||||||
/// [PusTc::calc_crc_on_serialization] is set to False. It will calculate and cache the CRC16.
|
|
||||||
pub fn calc_own_crc16(&mut self) {
|
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
|
||||||
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
|
||||||
digest.update(sph_zc.as_bytes());
|
|
||||||
let pus_tc_header = zc::PusTcSecondaryHeader::try_from(self.sec_header).unwrap();
|
|
||||||
digest.update(pus_tc_header.as_bytes());
|
|
||||||
if !self.app_data.is_empty() {
|
|
||||||
digest.update(self.app_data);
|
|
||||||
}
|
|
||||||
self.crc16 = Some(digest.finalize())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This helper function calls both [PusTc::update_ccsds_data_len] and [PusTc::calc_own_crc16].
|
|
||||||
pub fn update_packet_fields(&mut self) {
|
|
||||||
self.update_ccsds_data_len();
|
|
||||||
self.calc_own_crc16();
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
|
|
||||||
pub fn append_to_vec(&self, vec: &mut Vec<u8>) -> Result<usize, PusError> {
|
|
||||||
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
|
||||||
let appended_len = PUS_TC_MIN_LEN_WITHOUT_APP_DATA + self.app_data.len();
|
|
||||||
let start_idx = vec.len();
|
|
||||||
let mut ser_len = 0;
|
|
||||||
vec.extend_from_slice(sph_zc.as_bytes());
|
|
||||||
ser_len += sph_zc.as_bytes().len();
|
|
||||||
// The PUS version is hardcoded to PUS C
|
|
||||||
let pus_tc_header = zc::PusTcSecondaryHeader::try_from(self.sec_header).unwrap();
|
|
||||||
vec.extend_from_slice(pus_tc_header.as_bytes());
|
|
||||||
ser_len += pus_tc_header.as_bytes().len();
|
|
||||||
vec.extend_from_slice(self.app_data);
|
|
||||||
ser_len += self.app_data.len();
|
|
||||||
let crc16 = crc_procedure(
|
|
||||||
self.calc_crc_on_serialization,
|
|
||||||
&self.crc16,
|
|
||||||
start_idx,
|
|
||||||
ser_len,
|
|
||||||
&vec[start_idx..ser_len],
|
|
||||||
)?;
|
|
||||||
vec.extend_from_slice(crc16.to_be_bytes().as_slice());
|
|
||||||
Ok(appended_len)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Create a [PusTc] instance from a raw slice. On success, it returns a tuple containing
|
|
||||||
/// the instance and the found byte length of the packet.
|
|
||||||
#[deprecated(
|
|
||||||
since = "0.7.0",
|
|
||||||
note = "Use specialized PusTcCreator or PusTcReader classes instead"
|
|
||||||
)]
|
|
||||||
pub fn from_bytes(slice: &'raw_data [u8]) -> Result<(Self, usize), PusError> {
|
|
||||||
let raw_data_len = slice.len();
|
|
||||||
if raw_data_len < PUS_TC_MIN_LEN_WITHOUT_APP_DATA {
|
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
|
||||||
found: raw_data_len,
|
|
||||||
expected: PUS_TC_MIN_LEN_WITHOUT_APP_DATA,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
let mut current_idx = 0;
|
|
||||||
let (sp_header, _) = SpHeader::from_be_bytes(&slice[0..CCSDS_HEADER_LEN])?;
|
|
||||||
current_idx += CCSDS_HEADER_LEN;
|
|
||||||
let total_len = sp_header.total_len();
|
|
||||||
if raw_data_len < total_len || total_len < PUS_TC_MIN_LEN_WITHOUT_APP_DATA {
|
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
|
||||||
found: raw_data_len,
|
|
||||||
expected: total_len,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
let sec_header = zc::PusTcSecondaryHeader::from_bytes(
|
|
||||||
&slice[current_idx..current_idx + PUC_TC_SECONDARY_HEADER_LEN],
|
|
||||||
)
|
|
||||||
.ok_or(ByteConversionError::ZeroCopyFromError)?;
|
|
||||||
current_idx += PUC_TC_SECONDARY_HEADER_LEN;
|
|
||||||
let raw_data = &slice[0..total_len];
|
|
||||||
let pus_tc = Self {
|
|
||||||
sp_header,
|
|
||||||
sec_header: PusTcSecondaryHeader::try_from(sec_header).unwrap(),
|
|
||||||
raw_data: Some(raw_data),
|
|
||||||
app_data: user_data_from_raw(current_idx, total_len, slice)?,
|
|
||||||
calc_crc_on_serialization: false,
|
|
||||||
crc16: Some(crc_from_raw_data(raw_data)?),
|
|
||||||
};
|
|
||||||
verify_crc16_ccitt_false_from_raw_to_pus_error(
|
|
||||||
raw_data,
|
|
||||||
pus_tc.crc16.expect("CRC16 invalid"),
|
|
||||||
)?;
|
|
||||||
Ok((pus_tc, total_len))
|
|
||||||
}
|
|
||||||
|
|
||||||
#[deprecated(since = "0.5.2", note = "use raw_bytes() instead")]
|
|
||||||
pub fn raw(&self) -> Option<&'raw_data [u8]> {
|
|
||||||
self.raw_bytes()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// If [Self] was constructed [Self::from_bytes], this function will return the slice it was
|
|
||||||
/// constructed from. Otherwise, [None] will be returned.
|
|
||||||
pub fn raw_bytes(&self) -> Option<&'raw_data [u8]> {
|
|
||||||
self.raw_data
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl WritablePusPacket for PusTc<'_> {
|
|
||||||
fn len_written(&self) -> usize {
|
|
||||||
PUS_TC_MIN_LEN_WITHOUT_APP_DATA + self.app_data.len()
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Write the raw PUS byte representation to a provided buffer.
|
|
||||||
fn write_to_bytes(&self, slice: &mut [u8]) -> Result<usize, PusError> {
|
|
||||||
let mut curr_idx = 0;
|
|
||||||
let tc_header_len = size_of::<zc::PusTcSecondaryHeader>();
|
|
||||||
let total_size = self.len_written();
|
|
||||||
if total_size > slice.len() {
|
|
||||||
return Err(ByteConversionError::ToSliceTooSmall {
|
|
||||||
found: slice.len(),
|
|
||||||
expected: total_size,
|
|
||||||
}
|
|
||||||
.into());
|
|
||||||
}
|
|
||||||
self.sp_header.write_to_be_bytes(slice)?;
|
|
||||||
curr_idx += CCSDS_HEADER_LEN;
|
|
||||||
let sec_header = zc::PusTcSecondaryHeader::try_from(self.sec_header).unwrap();
|
|
||||||
sec_header
|
|
||||||
.write_to_bytes(&mut slice[curr_idx..curr_idx + tc_header_len])
|
|
||||||
.ok_or(ByteConversionError::ZeroCopyToError)?;
|
|
||||||
|
|
||||||
curr_idx += tc_header_len;
|
|
||||||
slice[curr_idx..curr_idx + self.app_data.len()].copy_from_slice(self.app_data);
|
|
||||||
curr_idx += self.app_data.len();
|
|
||||||
let crc16 = crc_procedure(
|
|
||||||
self.calc_crc_on_serialization,
|
|
||||||
&self.crc16,
|
|
||||||
0,
|
|
||||||
curr_idx,
|
|
||||||
slice,
|
|
||||||
)?;
|
|
||||||
slice[curr_idx..curr_idx + 2].copy_from_slice(crc16.to_be_bytes().as_slice());
|
|
||||||
curr_idx += 2;
|
|
||||||
Ok(curr_idx)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PartialEq for PusTc<'_> {
|
|
||||||
fn eq(&self, other: &Self) -> bool {
|
|
||||||
self.sp_header == other.sp_header
|
|
||||||
&& self.sec_header == other.sec_header
|
|
||||||
&& self.app_data == other.app_data
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl CcsdsPacket for PusTc<'_> {
|
|
||||||
ccsds_impl!();
|
|
||||||
}
|
|
||||||
|
|
||||||
impl PusPacket for PusTc<'_> {
|
|
||||||
delegate!(to self.sec_header {
|
|
||||||
fn pus_version(&self) -> PusVersion;
|
|
||||||
fn service(&self) -> u8;
|
|
||||||
fn subservice(&self) -> u8;
|
|
||||||
});
|
|
||||||
|
|
||||||
fn user_data(&self) -> &[u8] {
|
|
||||||
self.app_data
|
|
||||||
}
|
|
||||||
|
|
||||||
fn crc16(&self) -> Option<u16> {
|
|
||||||
self.crc16
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTc<'_> {
|
|
||||||
delegate!(to self.sec_header {
|
|
||||||
fn pus_version(&self) -> PusVersion;
|
|
||||||
fn service(&self) -> u8;
|
|
||||||
fn subservice(&self) -> u8;
|
|
||||||
fn source_id(&self) -> u16;
|
|
||||||
fn ack_flags(&self) -> u8;
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
impl IsPusTelecommand for PusTc<'_> {}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// This class can be used to create PUS C telecommand packet. It is the primary data structure to
|
/// This class can be used to create PUS C telecommand packet. It is the primary data structure to
|
||||||
/// generate the raw byte representation of a PUS telecommand.
|
/// generate the raw byte representation of a PUS telecommand.
|
||||||
///
|
///
|
||||||
|
@ -549,35 +236,37 @@ pub mod legacy_tc {
|
||||||
/// There is no spare bytes support yet.
|
/// There is no spare bytes support yet.
|
||||||
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
|
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
pub struct PusTcCreator<'raw_data> {
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
|
pub struct PusTcCreator<'app_data> {
|
||||||
sp_header: SpHeader,
|
sp_header: SpHeader,
|
||||||
pub sec_header: PusTcSecondaryHeader,
|
pub sec_header: PusTcSecondaryHeader,
|
||||||
app_data: &'raw_data [u8],
|
app_data: &'app_data [u8],
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'raw_data> PusTcCreator<'raw_data> {
|
impl<'app_data> PusTcCreator<'app_data> {
|
||||||
/// Generates a new struct instance.
|
/// Generates a new struct instance.
|
||||||
///
|
///
|
||||||
/// # Arguments
|
/// # Arguments
|
||||||
///
|
///
|
||||||
/// * `sp_header` - Space packet header information. The correct packet type will be set
|
/// * `sp_header` - Space packet header information. The correct packet type and the secondary
|
||||||
/// automatically
|
/// header flag are set correctly by the constructor.
|
||||||
/// * `sec_header` - Information contained in the data field header, including the service
|
/// * `sec_header` - Information contained in the data field header, including the service
|
||||||
/// and subservice type
|
/// and subservice type
|
||||||
/// * `app_data` - Custom application data
|
/// * `app_data` - Custom application data
|
||||||
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
/// * `set_ccsds_len` - Can be used to automatically update the CCSDS space packet data length
|
||||||
/// field. If this is not set to true, [PusTc::update_ccsds_data_len] can be called to set
|
/// field. If this is not set to true, [Self::update_ccsds_data_len] can be called to set
|
||||||
/// the correct value to this field manually
|
/// the correct value to this field manually
|
||||||
|
#[inline]
|
||||||
pub fn new(
|
pub fn new(
|
||||||
sp_header: &mut SpHeader,
|
mut sp_header: SpHeader,
|
||||||
sec_header: PusTcSecondaryHeader,
|
sec_header: PusTcSecondaryHeader,
|
||||||
app_data: &'raw_data [u8],
|
app_data: &'app_data [u8],
|
||||||
set_ccsds_len: bool,
|
set_ccsds_len: bool,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
sp_header.set_packet_type(PacketType::Tc);
|
sp_header.set_packet_type(PacketType::Tc);
|
||||||
sp_header.set_sec_header_flag();
|
sp_header.set_sec_header_flag();
|
||||||
let mut pus_tc = Self {
|
let mut pus_tc = Self {
|
||||||
sp_header: *sp_header,
|
sp_header,
|
||||||
app_data,
|
app_data,
|
||||||
sec_header,
|
sec_header,
|
||||||
};
|
};
|
||||||
|
@ -587,35 +276,44 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
||||||
pus_tc
|
pus_tc
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Simplified version of the [PusTcCreator::new] function which allows to only specify service
|
/// Simplified version of the [Self::new] function which allows to only specify service
|
||||||
/// and subservice instead of the full PUS TC secondary header.
|
/// and subservice instead of the full PUS TC secondary header.
|
||||||
|
#[inline]
|
||||||
pub fn new_simple(
|
pub fn new_simple(
|
||||||
sph: &mut SpHeader,
|
sph: SpHeader,
|
||||||
service: u8,
|
service: u8,
|
||||||
subservice: u8,
|
subservice: u8,
|
||||||
app_data: Option<&'raw_data [u8]>,
|
app_data: &'app_data [u8],
|
||||||
set_ccsds_len: bool,
|
set_ccsds_len: bool,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
Self::new(
|
Self::new(
|
||||||
sph,
|
sph,
|
||||||
PusTcSecondaryHeader::new(service, subservice, ACK_ALL, 0),
|
PusTcSecondaryHeader::new(service, subservice, ACK_ALL, 0),
|
||||||
app_data.unwrap_or(&[]),
|
app_data,
|
||||||
set_ccsds_len,
|
set_ccsds_len,
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn new_no_app_data(
|
pub fn new_no_app_data(
|
||||||
sp_header: &mut SpHeader,
|
sp_header: SpHeader,
|
||||||
sec_header: PusTcSecondaryHeader,
|
sec_header: PusTcSecondaryHeader,
|
||||||
set_ccsds_len: bool,
|
set_ccsds_len: bool,
|
||||||
) -> Self {
|
) -> Self {
|
||||||
Self::new(sp_header, sec_header, &[], set_ccsds_len)
|
Self::new(sp_header, sec_header, &[], set_ccsds_len)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn sp_header(&self) -> &SpHeader {
|
pub fn sp_header(&self) -> &SpHeader {
|
||||||
&self.sp_header
|
&self.sp_header
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
pub fn sp_header_mut(&mut self) -> &mut SpHeader {
|
||||||
|
&mut self.sp_header
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn set_ack_field(&mut self, ack: u8) -> bool {
|
pub fn set_ack_field(&mut self, ack: u8) -> bool {
|
||||||
if ack > 0b1111 {
|
if ack > 0b1111 {
|
||||||
return false;
|
return false;
|
||||||
|
@ -624,6 +322,7 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn set_source_id(&mut self, source_id: u16) {
|
pub fn set_source_id(&mut self, source_id: u16) {
|
||||||
self.sec_header.source_id = source_id;
|
self.sec_header.source_id = source_id;
|
||||||
}
|
}
|
||||||
|
@ -631,18 +330,18 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
||||||
sp_header_impls!();
|
sp_header_impls!();
|
||||||
|
|
||||||
/// Calculate the CCSDS space packet data length field and sets it
|
/// Calculate the CCSDS space packet data length field and sets it
|
||||||
/// This is called automatically if the `set_ccsds_len` argument in the [PusTc::new] call was
|
/// This is called automatically if the `set_ccsds_len` argument in the [Self::new] call was
|
||||||
/// used.
|
/// used.
|
||||||
/// If this was not done or the application data is set or changed after construction,
|
/// If this was not done or the application data is set or changed after construction,
|
||||||
/// this function needs to be called to ensure that the data length field of the CCSDS header
|
/// this function needs to be called to ensure that the data length field of the CCSDS header
|
||||||
/// is set correctly.
|
/// is set correctly.
|
||||||
|
#[inline]
|
||||||
pub fn update_ccsds_data_len(&mut self) {
|
pub fn update_ccsds_data_len(&mut self) {
|
||||||
self.sp_header.data_len =
|
self.sp_header.data_len =
|
||||||
self.len_written() as u16 - size_of::<crate::zc::SpHeader>() as u16 - 1;
|
self.len_written() as u16 - size_of::<crate::zc::SpHeader>() as u16 - 1;
|
||||||
}
|
}
|
||||||
|
|
||||||
/// This function should be called before the TC packet is serialized if
|
/// This function calculates and returns the CRC16 for the current packet.
|
||||||
/// [PusTc::calc_crc_on_serialization] is set to False. It will calculate and cache the CRC16.
|
|
||||||
pub fn calc_own_crc16(&self) -> u16 {
|
pub fn calc_own_crc16(&self) -> u16 {
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
let mut digest = CRC_CCITT_FALSE.digest();
|
||||||
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
||||||
|
@ -654,8 +353,7 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
|
pub fn append_to_vec(&self, vec: &mut Vec<u8>) -> usize {
|
||||||
pub fn append_to_vec(&self, vec: &mut Vec<u8>) -> Result<usize, PusError> {
|
|
||||||
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
let sph_zc = crate::zc::SpHeader::from(self.sp_header);
|
||||||
let mut appended_len = PUS_TC_MIN_LEN_WITHOUT_APP_DATA;
|
let mut appended_len = PUS_TC_MIN_LEN_WITHOUT_APP_DATA;
|
||||||
appended_len += self.app_data.len();
|
appended_len += self.app_data.len();
|
||||||
|
@ -668,11 +366,12 @@ impl<'raw_data> PusTcCreator<'raw_data> {
|
||||||
let mut digest = CRC_CCITT_FALSE.digest();
|
let mut digest = CRC_CCITT_FALSE.digest();
|
||||||
digest.update(&vec[start_idx..start_idx + appended_len - 2]);
|
digest.update(&vec[start_idx..start_idx + appended_len - 2]);
|
||||||
vec.extend_from_slice(&digest.finalize().to_be_bytes());
|
vec.extend_from_slice(&digest.finalize().to_be_bytes());
|
||||||
Ok(appended_len)
|
appended_len
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl WritablePusPacket for PusTcCreator<'_> {
|
impl WritablePusPacket for PusTcCreator<'_> {
|
||||||
|
#[inline]
|
||||||
fn len_written(&self) -> usize {
|
fn len_written(&self) -> usize {
|
||||||
PUS_TC_MIN_LEN_WITHOUT_APP_DATA + self.app_data.len()
|
PUS_TC_MIN_LEN_WITHOUT_APP_DATA + self.app_data.len()
|
||||||
}
|
}
|
||||||
|
@ -713,15 +412,20 @@ impl CcsdsPacket for PusTcCreator<'_> {
|
||||||
|
|
||||||
impl PusPacket for PusTcCreator<'_> {
|
impl PusPacket for PusTcCreator<'_> {
|
||||||
delegate!(to self.sec_header {
|
delegate!(to self.sec_header {
|
||||||
|
#[inline]
|
||||||
fn pus_version(&self) -> PusVersion;
|
fn pus_version(&self) -> PusVersion;
|
||||||
|
#[inline]
|
||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
|
#[inline]
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
});
|
});
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn user_data(&self) -> &[u8] {
|
fn user_data(&self) -> &[u8] {
|
||||||
self.app_data
|
self.app_data
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn crc16(&self) -> Option<u16> {
|
fn crc16(&self) -> Option<u16> {
|
||||||
Some(self.calc_own_crc16())
|
Some(self.calc_own_crc16())
|
||||||
}
|
}
|
||||||
|
@ -729,10 +433,15 @@ impl PusPacket for PusTcCreator<'_> {
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTcCreator<'_> {
|
impl GenericPusTcSecondaryHeader for PusTcCreator<'_> {
|
||||||
delegate!(to self.sec_header {
|
delegate!(to self.sec_header {
|
||||||
|
#[inline]
|
||||||
fn pus_version(&self) -> PusVersion;
|
fn pus_version(&self) -> PusVersion;
|
||||||
|
#[inline]
|
||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
|
#[inline]
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
|
#[inline]
|
||||||
fn source_id(&self) -> u16;
|
fn source_id(&self) -> u16;
|
||||||
|
#[inline]
|
||||||
fn ack_flags(&self) -> u8;
|
fn ack_flags(&self) -> u8;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -752,6 +461,7 @@ impl IsPusTelecommand for PusTcCreator<'_> {}
|
||||||
/// * `'raw_data` - Lifetime of the provided raw slice.
|
/// * `'raw_data` - Lifetime of the provided raw slice.
|
||||||
#[derive(Eq, Copy, Clone, Debug)]
|
#[derive(Eq, Copy, Clone, Debug)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct PusTcReader<'raw_data> {
|
pub struct PusTcReader<'raw_data> {
|
||||||
#[cfg_attr(feature = "serde", serde(skip))]
|
#[cfg_attr(feature = "serde", serde(skip))]
|
||||||
raw_data: &'raw_data [u8],
|
raw_data: &'raw_data [u8],
|
||||||
|
@ -763,7 +473,8 @@ pub struct PusTcReader<'raw_data> {
|
||||||
|
|
||||||
impl<'raw_data> PusTcReader<'raw_data> {
|
impl<'raw_data> PusTcReader<'raw_data> {
|
||||||
/// Create a [PusTcReader] instance from a raw slice. On success, it returns a tuple containing
|
/// Create a [PusTcReader] instance from a raw slice. On success, it returns a tuple containing
|
||||||
/// the instance and the found byte length of the packet.
|
/// the instance and the found byte length of the packet. This function also performs a CRC
|
||||||
|
/// check and will return an appropriate [PusError] if the check fails.
|
||||||
pub fn new(slice: &'raw_data [u8]) -> Result<(Self, usize), PusError> {
|
pub fn new(slice: &'raw_data [u8]) -> Result<(Self, usize), PusError> {
|
||||||
let raw_data_len = slice.len();
|
let raw_data_len = slice.len();
|
||||||
if raw_data_len < PUS_TC_MIN_LEN_WITHOUT_APP_DATA {
|
if raw_data_len < PUS_TC_MIN_LEN_WITHOUT_APP_DATA {
|
||||||
|
@ -808,24 +519,29 @@ impl<'raw_data> PusTcReader<'raw_data> {
|
||||||
Ok((pus_tc, total_len))
|
Ok((pus_tc, total_len))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn app_data(&self) -> &[u8] {
|
pub fn app_data(&self) -> &[u8] {
|
||||||
self.user_data()
|
self.user_data()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn raw_data(&self) -> &[u8] {
|
pub fn raw_data(&self) -> &[u8] {
|
||||||
self.raw_data
|
self.raw_data
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn len_packed(&self) -> usize {
|
pub fn len_packed(&self) -> usize {
|
||||||
self.sp_header.total_len()
|
self.sp_header.total_len()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn sp_header(&self) -> &SpHeader {
|
pub fn sp_header(&self) -> &SpHeader {
|
||||||
&self.sp_header
|
&self.sp_header
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PartialEq for PusTcReader<'_> {
|
impl PartialEq for PusTcReader<'_> {
|
||||||
|
#[inline]
|
||||||
fn eq(&self, other: &Self) -> bool {
|
fn eq(&self, other: &Self) -> bool {
|
||||||
self.raw_data == other.raw_data
|
self.raw_data == other.raw_data
|
||||||
}
|
}
|
||||||
|
@ -837,15 +553,20 @@ impl CcsdsPacket for PusTcReader<'_> {
|
||||||
|
|
||||||
impl PusPacket for PusTcReader<'_> {
|
impl PusPacket for PusTcReader<'_> {
|
||||||
delegate!(to self.sec_header {
|
delegate!(to self.sec_header {
|
||||||
|
#[inline]
|
||||||
fn pus_version(&self) -> PusVersion;
|
fn pus_version(&self) -> PusVersion;
|
||||||
|
#[inline]
|
||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
|
#[inline]
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
});
|
});
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn user_data(&self) -> &[u8] {
|
fn user_data(&self) -> &[u8] {
|
||||||
self.app_data
|
self.app_data
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn crc16(&self) -> Option<u16> {
|
fn crc16(&self) -> Option<u16> {
|
||||||
Some(self.crc16)
|
Some(self.crc16)
|
||||||
}
|
}
|
||||||
|
@ -853,10 +574,15 @@ impl PusPacket for PusTcReader<'_> {
|
||||||
|
|
||||||
impl GenericPusTcSecondaryHeader for PusTcReader<'_> {
|
impl GenericPusTcSecondaryHeader for PusTcReader<'_> {
|
||||||
delegate!(to self.sec_header {
|
delegate!(to self.sec_header {
|
||||||
|
#[inline]
|
||||||
fn pus_version(&self) -> PusVersion;
|
fn pus_version(&self) -> PusVersion;
|
||||||
|
#[inline]
|
||||||
fn service(&self) -> u8;
|
fn service(&self) -> u8;
|
||||||
|
#[inline]
|
||||||
fn subservice(&self) -> u8;
|
fn subservice(&self) -> u8;
|
||||||
|
#[inline]
|
||||||
fn source_id(&self) -> u16;
|
fn source_id(&self) -> u16;
|
||||||
|
#[inline]
|
||||||
fn ack_flags(&self) -> u8;
|
fn ack_flags(&self) -> u8;
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
@ -894,19 +620,19 @@ mod tests {
|
||||||
use postcard::{from_bytes, to_allocvec};
|
use postcard::{from_bytes, to_allocvec};
|
||||||
|
|
||||||
fn base_ping_tc_full_ctor() -> PusTcCreator<'static> {
|
fn base_ping_tc_full_ctor() -> PusTcCreator<'static> {
|
||||||
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
||||||
let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
let tc_header = PusTcSecondaryHeader::new_simple(17, 1);
|
||||||
PusTcCreator::new_no_app_data(&mut sph, tc_header, true)
|
PusTcCreator::new_no_app_data(sph, tc_header, true)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn base_ping_tc_simple_ctor() -> PusTcCreator<'static> {
|
fn base_ping_tc_simple_ctor() -> PusTcCreator<'static> {
|
||||||
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
||||||
PusTcCreator::new_simple(&mut sph, 17, 1, None, true)
|
PusTcCreator::new_simple(sph, 17, 1, &[], true)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn base_ping_tc_simple_ctor_with_app_data(app_data: &'static [u8]) -> PusTcCreator<'static> {
|
fn base_ping_tc_simple_ctor_with_app_data(app_data: &'static [u8]) -> PusTcCreator<'static> {
|
||||||
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
||||||
PusTcCreator::new_simple(&mut sph, 17, 1, Some(app_data), true)
|
PusTcCreator::new_simple(sph, 17, 1, app_data, true)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -962,8 +688,8 @@ mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_update_func() {
|
fn test_update_func() {
|
||||||
let mut sph = SpHeader::tc_unseg(0x02, 0x34, 0).unwrap();
|
let sph = SpHeader::new_for_unseg_tc_checked(0x02, 0x34, 0).unwrap();
|
||||||
let mut tc = PusTcCreator::new_simple(&mut sph, 17, 1, None, false);
|
let mut tc = PusTcCreator::new_simple(sph, 17, 1, &[], false);
|
||||||
assert_eq!(tc.data_len(), 0);
|
assert_eq!(tc.data_len(), 0);
|
||||||
tc.update_ccsds_data_len();
|
tc.update_ccsds_data_len();
|
||||||
assert_eq!(tc.data_len(), 6);
|
assert_eq!(tc.data_len(), 6);
|
||||||
|
@ -1010,9 +736,7 @@ mod tests {
|
||||||
fn test_vec_ser_deser() {
|
fn test_vec_ser_deser() {
|
||||||
let pus_tc = base_ping_tc_simple_ctor();
|
let pus_tc = base_ping_tc_simple_ctor();
|
||||||
let mut test_vec = Vec::new();
|
let mut test_vec = Vec::new();
|
||||||
let size = pus_tc
|
let size = pus_tc.append_to_vec(&mut test_vec);
|
||||||
.append_to_vec(&mut test_vec)
|
|
||||||
.expect("Error writing TC to vector");
|
|
||||||
assert_eq!(size, 13);
|
assert_eq!(size, 13);
|
||||||
verify_test_tc_raw(&test_vec.as_slice());
|
verify_test_tc_raw(&test_vec.as_slice());
|
||||||
verify_crc_no_app_data(&test_vec.as_slice());
|
verify_crc_no_app_data(&test_vec.as_slice());
|
||||||
|
@ -1058,9 +782,7 @@ mod tests {
|
||||||
let pus_tc = base_ping_tc_simple_ctor_with_app_data(&[1, 2, 3]);
|
let pus_tc = base_ping_tc_simple_ctor_with_app_data(&[1, 2, 3]);
|
||||||
verify_test_tc(&pus_tc, true, 16);
|
verify_test_tc(&pus_tc, true, 16);
|
||||||
let mut test_vec = Vec::new();
|
let mut test_vec = Vec::new();
|
||||||
let size = pus_tc
|
let size = pus_tc.append_to_vec(&mut test_vec);
|
||||||
.append_to_vec(&mut test_vec)
|
|
||||||
.expect("Error writing TC to vector");
|
|
||||||
assert_eq!(test_vec[11], 1);
|
assert_eq!(test_vec[11], 1);
|
||||||
assert_eq!(test_vec[12], 2);
|
assert_eq!(test_vec[12], 2);
|
||||||
assert_eq!(test_vec[13], 3);
|
assert_eq!(test_vec[13], 3);
|
||||||
|
@ -1139,7 +861,8 @@ mod tests {
|
||||||
if !has_user_data {
|
if !has_user_data {
|
||||||
assert!(tc.user_data().is_empty());
|
assert!(tc.user_data().is_empty());
|
||||||
}
|
}
|
||||||
let mut comp_header = SpHeader::tc_unseg(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
let mut comp_header =
|
||||||
|
SpHeader::new_for_unseg_tc_checked(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
||||||
comp_header.set_sec_header_flag();
|
comp_header.set_sec_header_flag();
|
||||||
assert_eq!(*tc.sp_header(), comp_header);
|
assert_eq!(*tc.sp_header(), comp_header);
|
||||||
}
|
}
|
||||||
|
@ -1150,7 +873,8 @@ mod tests {
|
||||||
assert!(tc.user_data().is_empty());
|
assert!(tc.user_data().is_empty());
|
||||||
}
|
}
|
||||||
assert_eq!(tc.len_packed(), exp_full_len);
|
assert_eq!(tc.len_packed(), exp_full_len);
|
||||||
let mut comp_header = SpHeader::tc_unseg(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
let mut comp_header =
|
||||||
|
SpHeader::new_for_unseg_tc_checked(0x02, 0x34, exp_full_len as u16 - 7).unwrap();
|
||||||
comp_header.set_sec_header_flag();
|
comp_header.set_sec_header_flag();
|
||||||
assert_eq!(*tc.sp_header(), comp_header);
|
assert_eq!(*tc.sp_header(), comp_header);
|
||||||
}
|
}
|
||||||
|
|
833
src/ecss/tm.rs
833
src/ecss/tm.rs
File diff suppressed because it is too large
Load Diff
375
src/lib.rs
375
src/lib.rs
|
@ -22,10 +22,6 @@
|
||||||
//!
|
//!
|
||||||
//! `spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
//! `spacepackets` supports various runtime environments and is also suitable for `no_std` environments.
|
||||||
//!
|
//!
|
||||||
//! It also offers optional support for [`serde`](https://serde.rs/). This allows serializing and
|
|
||||||
//! deserializing them with an appropriate `serde` provider like
|
|
||||||
//! [`postcard`](https://github.com/jamesmunns/postcard).
|
|
||||||
//!
|
|
||||||
//! ### Default features
|
//! ### Default features
|
||||||
//!
|
//!
|
||||||
//! - [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library.
|
//! - [`std`](https://doc.rust-lang.org/std/): Enables functionality relying on the standard library.
|
||||||
|
@ -36,7 +32,11 @@
|
||||||
//! ### Optional features
|
//! ### Optional features
|
||||||
//!
|
//!
|
||||||
//! - [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and
|
//! - [`serde`](https://serde.rs/): Adds `serde` support for most types by adding `Serialize` and
|
||||||
//! `Deserialize` `derive`s
|
//! `Deserialize` `derives.
|
||||||
|
//! - [`chrono`](https://crates.io/crates/chrono): Add basic support for the `chrono` time library.
|
||||||
|
//! - [`timelib`](https://crates.io/crates/time): Add basic support for the `time` time library.
|
||||||
|
//! - [`defmt`](https://defmt.ferrous-systems.com/): Add support for the `defmt` by adding the
|
||||||
|
//! [`defmt::Format`](https://defmt.ferrous-systems.com/format) derive on many types.
|
||||||
//!
|
//!
|
||||||
//! ## Module
|
//! ## Module
|
||||||
//!
|
//!
|
||||||
|
@ -48,20 +48,19 @@
|
||||||
//!
|
//!
|
||||||
//! ```rust
|
//! ```rust
|
||||||
//! use spacepackets::SpHeader;
|
//! use spacepackets::SpHeader;
|
||||||
//! let sp_header = SpHeader::tc_unseg(0x42, 12, 1).expect("Error creating CCSDS TC header");
|
//! let sp_header = SpHeader::new_for_unseg_tc_checked(0x42, 12, 1).expect("error creating CCSDS TC header");
|
||||||
//! println!("{:?}", sp_header);
|
//! println!("{:?}", sp_header);
|
||||||
//! let mut ccsds_buf: [u8; 32] = [0; 32];
|
//! let mut ccsds_buf: [u8; 32] = [0; 32];
|
||||||
//! sp_header.write_to_be_bytes(&mut ccsds_buf).expect("Writing CCSDS TC header failed");
|
//! sp_header.write_to_be_bytes(&mut ccsds_buf).expect("Writing CCSDS TC header failed");
|
||||||
//! println!("{:x?}", &ccsds_buf[0..6]);
|
//! println!("{:x?}", &ccsds_buf[0..6]);
|
||||||
//! ```
|
//! ```
|
||||||
#![no_std]
|
#![no_std]
|
||||||
#![cfg_attr(doc_cfg, feature(doc_cfg))]
|
#![cfg_attr(docs_rs, feature(doc_auto_cfg))]
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(feature = "alloc")]
|
||||||
extern crate alloc;
|
extern crate alloc;
|
||||||
#[cfg(any(feature = "std", test))]
|
#[cfg(any(feature = "std", test))]
|
||||||
extern crate std;
|
extern crate std;
|
||||||
|
|
||||||
use crate::ecss::CCSDS_HEADER_LEN;
|
|
||||||
use core::{
|
use core::{
|
||||||
fmt::{Debug, Display, Formatter},
|
fmt::{Debug, Display, Formatter},
|
||||||
hash::Hash,
|
hash::Hash,
|
||||||
|
@ -84,6 +83,8 @@ mod private {
|
||||||
pub trait Sealed {}
|
pub trait Sealed {}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub const CCSDS_HEADER_LEN: usize = core::mem::size_of::<crate::zc::SpHeader>();
|
||||||
|
|
||||||
/// CRC algorithm used by the PUS standard, the CCSDS TC standard and the CFDP standard.
|
/// CRC algorithm used by the PUS standard, the CCSDS TC standard and the CFDP standard.
|
||||||
pub const CRC_CCITT_FALSE: Crc<u16> = Crc::<u16>::new(&CRC_16_IBM_3740);
|
pub const CRC_CCITT_FALSE: Crc<u16> = Crc::<u16>::new(&CRC_16_IBM_3740);
|
||||||
|
|
||||||
|
@ -93,6 +94,7 @@ pub const MAX_SEQ_COUNT: u16 = 2u16.pow(14) - 1;
|
||||||
/// Generic error type when converting to and from raw byte slices.
|
/// Generic error type when converting to and from raw byte slices.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum ByteConversionError {
|
pub enum ByteConversionError {
|
||||||
/// The passed slice is too small. Returns the passed slice length and expected minimum size
|
/// The passed slice is too small. Returns the passed slice length and expected minimum size
|
||||||
ToSliceTooSmall {
|
ToSliceTooSmall {
|
||||||
|
@ -142,6 +144,7 @@ impl Error for ByteConversionError {}
|
||||||
/// CCSDS packet type enumeration.
|
/// CCSDS packet type enumeration.
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum PacketType {
|
pub enum PacketType {
|
||||||
Tm = 0,
|
Tm = 0,
|
||||||
Tc = 1,
|
Tc = 1,
|
||||||
|
@ -165,6 +168,7 @@ pub fn packet_type_in_raw_packet_id(packet_id: u16) -> PacketType {
|
||||||
|
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub enum SequenceFlags {
|
pub enum SequenceFlags {
|
||||||
ContinuationSegment = 0b00,
|
ContinuationSegment = 0b00,
|
||||||
FirstSegment = 0b01,
|
FirstSegment = 0b01,
|
||||||
|
@ -192,6 +196,7 @@ impl TryFrom<u8> for SequenceFlags {
|
||||||
/// of the first two bytes in the CCSDS primary header.
|
/// of the first two bytes in the CCSDS primary header.
|
||||||
#[derive(Debug, Eq, Copy, Clone)]
|
#[derive(Debug, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct PacketId {
|
pub struct PacketId {
|
||||||
pub ptype: PacketType,
|
pub ptype: PacketType,
|
||||||
pub sec_header_flag: bool,
|
pub sec_header_flag: bool,
|
||||||
|
@ -199,18 +204,21 @@ pub struct PacketId {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PartialEq for PacketId {
|
impl PartialEq for PacketId {
|
||||||
|
#[inline]
|
||||||
fn eq(&self, other: &Self) -> bool {
|
fn eq(&self, other: &Self) -> bool {
|
||||||
self.raw().eq(&other.raw())
|
self.raw().eq(&other.raw())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PartialOrd for PacketId {
|
impl PartialOrd for PacketId {
|
||||||
|
#[inline]
|
||||||
fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
|
fn partial_cmp(&self, other: &Self) -> Option<core::cmp::Ordering> {
|
||||||
Some(self.cmp(other))
|
Some(self.cmp(other))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Ord for PacketId {
|
impl Ord for PacketId {
|
||||||
|
#[inline]
|
||||||
fn cmp(&self, other: &Self) -> core::cmp::Ordering {
|
fn cmp(&self, other: &Self) -> core::cmp::Ordering {
|
||||||
self.raw().cmp(&other.raw())
|
self.raw().cmp(&other.raw())
|
||||||
}
|
}
|
||||||
|
@ -224,6 +232,7 @@ impl Hash for PacketId {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Default for PacketId {
|
impl Default for PacketId {
|
||||||
|
#[inline]
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
PacketId {
|
PacketId {
|
||||||
ptype: PacketType::Tm,
|
ptype: PacketType::Tm,
|
||||||
|
@ -234,23 +243,34 @@ impl Default for PacketId {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PacketId {
|
impl PacketId {
|
||||||
pub const fn const_tc(sec_header: bool, apid: u16) -> Self {
|
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
||||||
Self::const_new(PacketType::Tc, sec_header, apid)
|
/// Use the checked constructor variants to avoid panics.
|
||||||
}
|
#[inline]
|
||||||
|
pub const fn new_for_tc(sec_header: bool, apid: u16) -> Self {
|
||||||
pub const fn const_tm(sec_header: bool, apid: u16) -> Self {
|
|
||||||
Self::const_new(PacketType::Tm, sec_header, apid)
|
|
||||||
}
|
|
||||||
|
|
||||||
pub fn tc(sec_header: bool, apid: u16) -> Option<Self> {
|
|
||||||
Self::new(PacketType::Tc, sec_header, apid)
|
Self::new(PacketType::Tc, sec_header, apid)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn tm(sec_header: bool, apid: u16) -> Option<Self> {
|
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
||||||
|
/// Use the checked constructor variants to avoid panics.
|
||||||
|
#[inline]
|
||||||
|
pub const fn new_for_tm(sec_header: bool, apid: u16) -> Self {
|
||||||
Self::new(PacketType::Tm, sec_header, apid)
|
Self::new(PacketType::Tm, sec_header, apid)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub const fn const_new(ptype: PacketType, sec_header: bool, apid: u16) -> Self {
|
#[inline]
|
||||||
|
pub fn new_for_tc_checked(sec_header: bool, apid: u16) -> Option<Self> {
|
||||||
|
Self::new_checked(PacketType::Tc, sec_header, apid)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
pub fn new_for_tm_checked(sec_header: bool, apid: u16) -> Option<Self> {
|
||||||
|
Self::new_checked(PacketType::Tm, sec_header, apid)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// This constructor will panic if the passed APID exceeds [MAX_APID].
|
||||||
|
/// Use the checked variants to avoid panics.
|
||||||
|
#[inline]
|
||||||
|
pub const fn new(ptype: PacketType, sec_header: bool, apid: u16) -> Self {
|
||||||
if apid > MAX_APID {
|
if apid > MAX_APID {
|
||||||
panic!("APID too large");
|
panic!("APID too large");
|
||||||
}
|
}
|
||||||
|
@ -261,16 +281,18 @@ impl PacketId {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn new(ptype: PacketType, sec_header_flag: bool, apid: u16) -> Option<PacketId> {
|
#[inline]
|
||||||
|
pub fn new_checked(ptype: PacketType, sec_header_flag: bool, apid: u16) -> Option<PacketId> {
|
||||||
if apid > MAX_APID {
|
if apid > MAX_APID {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
Some(PacketId::const_new(ptype, sec_header_flag, apid))
|
Some(PacketId::new(ptype, sec_header_flag, apid))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Set a new Application Process ID (APID). If the passed number is invalid, the APID will
|
/// 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
|
/// not be set and false will be returned. The maximum allowed value for the 11-bit field is
|
||||||
/// 2047
|
/// 2047
|
||||||
|
#[inline]
|
||||||
pub fn set_apid(&mut self, apid: u16) -> bool {
|
pub fn set_apid(&mut self, apid: u16) -> bool {
|
||||||
if apid > MAX_APID {
|
if apid > MAX_APID {
|
||||||
return false;
|
return false;
|
||||||
|
@ -279,6 +301,7 @@ impl PacketId {
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn apid(&self) -> u16 {
|
pub fn apid(&self) -> u16 {
|
||||||
self.apid
|
self.apid
|
||||||
}
|
}
|
||||||
|
@ -303,15 +326,17 @@ impl From<u16> for PacketId {
|
||||||
/// third and the fourth byte in the CCSDS primary header.
|
/// third and the fourth byte in the CCSDS primary header.
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct PacketSequenceCtrl {
|
pub struct PacketSequenceCtrl {
|
||||||
pub seq_flags: SequenceFlags,
|
pub seq_flags: SequenceFlags,
|
||||||
seq_count: u16,
|
seq_count: u16,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PacketSequenceCtrl {
|
impl PacketSequenceCtrl {
|
||||||
/// const variant of [PacketSequenceCtrl::new], but panics if the sequence count exceeds
|
/// This constructor panics if the sequence count exceeds [MAX_SEQ_COUNT].
|
||||||
/// [MAX_SEQ_COUNT].
|
/// Use [Self::new_checked] to avoid panics.
|
||||||
pub const fn const_new(seq_flags: SequenceFlags, seq_count: u16) -> PacketSequenceCtrl {
|
#[inline]
|
||||||
|
pub const fn new(seq_flags: SequenceFlags, seq_count: u16) -> PacketSequenceCtrl {
|
||||||
if seq_count > MAX_SEQ_COUNT {
|
if seq_count > MAX_SEQ_COUNT {
|
||||||
panic!("Sequence count too large");
|
panic!("Sequence count too large");
|
||||||
}
|
}
|
||||||
|
@ -322,18 +347,22 @@ impl PacketSequenceCtrl {
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns [None] if the passed sequence count exceeds [MAX_SEQ_COUNT].
|
/// Returns [None] if the passed sequence count exceeds [MAX_SEQ_COUNT].
|
||||||
pub fn new(seq_flags: SequenceFlags, seq_count: u16) -> Option<PacketSequenceCtrl> {
|
#[inline]
|
||||||
|
pub fn new_checked(seq_flags: SequenceFlags, seq_count: u16) -> Option<PacketSequenceCtrl> {
|
||||||
if seq_count > MAX_SEQ_COUNT {
|
if seq_count > MAX_SEQ_COUNT {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
Some(PacketSequenceCtrl::const_new(seq_flags, seq_count))
|
Some(PacketSequenceCtrl::new(seq_flags, seq_count))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn raw(&self) -> u16 {
|
pub fn raw(&self) -> u16 {
|
||||||
((self.seq_flags as u16) << 14) | self.seq_count
|
((self.seq_flags as u16) << 14) | self.seq_count
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Set a new sequence count. If the passed number is invalid, the sequence count will not be
|
/// Set a new sequence count. If the passed number is invalid, the sequence count will not be
|
||||||
/// set and false will be returned. The maximum allowed value for the 14-bit field is 16383.
|
/// set and false will be returned. The maximum allowed value for the 14-bit field is 16383.
|
||||||
|
#[inline]
|
||||||
pub fn set_seq_count(&mut self, ssc: u16) -> bool {
|
pub fn set_seq_count(&mut self, ssc: u16) -> bool {
|
||||||
if ssc > MAX_SEQ_COUNT {
|
if ssc > MAX_SEQ_COUNT {
|
||||||
return false;
|
return false;
|
||||||
|
@ -342,6 +371,7 @@ impl PacketSequenceCtrl {
|
||||||
true
|
true
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn seq_count(&self) -> u16 {
|
pub fn seq_count(&self) -> u16 {
|
||||||
self.seq_count
|
self.seq_count
|
||||||
}
|
}
|
||||||
|
@ -383,6 +413,7 @@ pub trait CcsdsPacket {
|
||||||
/// Retrieve data length field
|
/// Retrieve data length field
|
||||||
fn data_len(&self) -> u16;
|
fn data_len(&self) -> u16;
|
||||||
/// Retrieve the total packet size based on the data length field
|
/// Retrieve the total packet size based on the data length field
|
||||||
|
#[inline]
|
||||||
fn total_len(&self) -> usize {
|
fn total_len(&self) -> usize {
|
||||||
usize::from(self.data_len()) + CCSDS_HEADER_LEN + 1
|
usize::from(self.data_len()) + CCSDS_HEADER_LEN + 1
|
||||||
}
|
}
|
||||||
|
@ -463,6 +494,7 @@ pub trait CcsdsPrimaryHeader {
|
||||||
/// * `data_len` - Data length field occupies the fifth and the sixth byte of the raw header
|
/// * `data_len` - Data length field occupies the fifth and the sixth byte of the raw header
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct SpHeader {
|
pub struct SpHeader {
|
||||||
pub version: u8,
|
pub version: u8,
|
||||||
pub packet_id: PacketId,
|
pub packet_id: PacketId,
|
||||||
|
@ -470,9 +502,12 @@ pub struct SpHeader {
|
||||||
pub data_len: u16,
|
pub data_len: u16,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub type SpacePacketHeader = SpHeader;
|
||||||
|
|
||||||
impl Default for SpHeader {
|
impl Default for SpHeader {
|
||||||
/// The default function sets the sequence flag field to [SequenceFlags::Unsegmented]. The data
|
/// The default function sets the sequence flag field to [SequenceFlags::Unsegmented] and the
|
||||||
/// length field is set to 1, which denotes an empty space packets.
|
/// data length to 0.
|
||||||
|
#[inline]
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
SpHeader {
|
SpHeader {
|
||||||
version: 0,
|
version: 0,
|
||||||
|
@ -481,12 +516,13 @@ impl Default for SpHeader {
|
||||||
seq_flags: SequenceFlags::Unsegmented,
|
seq_flags: SequenceFlags::Unsegmented,
|
||||||
seq_count: 0,
|
seq_count: 0,
|
||||||
},
|
},
|
||||||
data_len: 1,
|
data_len: 0,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl SpHeader {
|
impl SpHeader {
|
||||||
|
#[inline]
|
||||||
pub const fn new(packet_id: PacketId, psc: PacketSequenceCtrl, data_len: u16) -> Self {
|
pub const fn new(packet_id: PacketId, psc: PacketSequenceCtrl, data_len: u16) -> Self {
|
||||||
Self {
|
Self {
|
||||||
version: 0,
|
version: 0,
|
||||||
|
@ -496,9 +532,43 @@ impl SpHeader {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// const variant of the [SpHeader::new_fron_single_fields] function. Panics if the passed
|
/// This constructor sets the sequence flag field to [SequenceFlags::Unsegmented] and the data
|
||||||
/// APID exceeds [MAX_APID] or the passed packet sequence count exceeds [MAX_SEQ_COUNT].
|
/// length to 0.
|
||||||
const fn const_new_from_single_fields(
|
///
|
||||||
|
/// This constructor will panic if the APID exceeds [MAX_APID].
|
||||||
|
#[inline]
|
||||||
|
pub const fn new_from_apid(apid: u16) -> Self {
|
||||||
|
SpHeader {
|
||||||
|
version: 0,
|
||||||
|
packet_id: PacketId::new(PacketType::Tm, false, apid),
|
||||||
|
psc: PacketSequenceCtrl {
|
||||||
|
seq_flags: SequenceFlags::Unsegmented,
|
||||||
|
seq_count: 0,
|
||||||
|
},
|
||||||
|
data_len: 0,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Checked variant of [Self::new_from_apid].
|
||||||
|
#[inline]
|
||||||
|
pub fn new_from_apid_checked(apid: u16) -> Option<Self> {
|
||||||
|
Some(SpHeader {
|
||||||
|
version: 0,
|
||||||
|
packet_id: PacketId::new_checked(PacketType::Tm, false, apid)?,
|
||||||
|
psc: PacketSequenceCtrl {
|
||||||
|
seq_flags: SequenceFlags::Unsegmented,
|
||||||
|
seq_count: 0,
|
||||||
|
},
|
||||||
|
data_len: 0,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 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.
|
||||||
|
#[inline]
|
||||||
|
pub const fn new_from_fields(
|
||||||
ptype: PacketType,
|
ptype: PacketType,
|
||||||
sec_header: bool,
|
sec_header: bool,
|
||||||
apid: u16,
|
apid: u16,
|
||||||
|
@ -513,17 +583,20 @@ impl SpHeader {
|
||||||
panic!("APID is too large");
|
panic!("APID is too large");
|
||||||
}
|
}
|
||||||
Self {
|
Self {
|
||||||
psc: PacketSequenceCtrl::const_new(seq_flags, seq_count),
|
psc: PacketSequenceCtrl::new(seq_flags, seq_count),
|
||||||
packet_id: PacketId::const_new(ptype, sec_header, apid),
|
packet_id: PacketId::new(ptype, sec_header, apid),
|
||||||
data_len,
|
data_len,
|
||||||
version: 0,
|
version: 0,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Create a new Space Packet Header instance which can be used to create generic
|
/// 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
|
/// 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.
|
/// exceed [MAX_APID] or [MAX_SEQ_COUNT] respectively. The version field is set to 0b000.
|
||||||
pub fn new_from_single_fields(
|
#[inline]
|
||||||
|
pub fn new_from_fields_checked(
|
||||||
ptype: PacketType,
|
ptype: PacketType,
|
||||||
sec_header: bool,
|
sec_header: bool,
|
||||||
apid: u16,
|
apid: u16,
|
||||||
|
@ -534,56 +607,117 @@ impl SpHeader {
|
||||||
if seq_count > MAX_SEQ_COUNT || apid > MAX_APID {
|
if seq_count > MAX_SEQ_COUNT || apid > MAX_APID {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
Some(SpHeader::const_new_from_single_fields(
|
Some(SpHeader::new_from_fields(
|
||||||
ptype, sec_header, apid, seq_flags, seq_count, data_len,
|
ptype, sec_header, apid, seq_flags, seq_count, data_len,
|
||||||
))
|
))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Helper function for telemetry space packet headers. The packet type field will be
|
/// Helper function for telemetry space packet headers. The packet type field will be
|
||||||
/// set accordingly. The secondary header flag field is set to false.
|
/// set accordingly. The secondary header flag field is set to false.
|
||||||
pub fn tm(apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16) -> Option<Self> {
|
#[inline]
|
||||||
Self::new_from_single_fields(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
pub fn new_for_tm_checked(
|
||||||
|
apid: u16,
|
||||||
|
seq_flags: SequenceFlags,
|
||||||
|
seq_count: u16,
|
||||||
|
data_len: u16,
|
||||||
|
) -> Option<Self> {
|
||||||
|
Self::new_from_fields_checked(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Helper function for telemetry space packet headers. The packet type field will be
|
/// Helper function for telemetry space packet headers. The packet type field will be
|
||||||
/// set accordingly. The secondary header flag field is set to false.
|
/// set accordingly. The secondary header flag field is set to false.
|
||||||
pub fn tc(apid: u16, seq_flags: SequenceFlags, seq_count: u16, data_len: u16) -> Option<Self> {
|
#[inline]
|
||||||
Self::new_from_single_fields(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
pub fn new_for_tc_checked(
|
||||||
|
apid: u16,
|
||||||
|
seq_flags: SequenceFlags,
|
||||||
|
seq_count: u16,
|
||||||
|
data_len: u16,
|
||||||
|
) -> Option<Self> {
|
||||||
|
Self::new_from_fields_checked(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Variant of [SpHeader::tm] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
/// This is an unchecked constructor which can panic on invalid input.
|
||||||
pub fn tm_unseg(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
#[inline]
|
||||||
Self::tm(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
pub const fn new_for_tm(
|
||||||
|
apid: u16,
|
||||||
|
seq_flags: SequenceFlags,
|
||||||
|
seq_count: u16,
|
||||||
|
data_len: u16,
|
||||||
|
) -> Self {
|
||||||
|
Self::new_from_fields(PacketType::Tm, false, apid, seq_flags, seq_count, data_len)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Variant of [SpHeader::tc] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
/// This is an unchecked constructor which can panic on invalid input.
|
||||||
pub fn tc_unseg(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
#[inline]
|
||||||
Self::tc(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
pub const fn new_for_tc(
|
||||||
|
apid: u16,
|
||||||
|
seq_flags: SequenceFlags,
|
||||||
|
seq_count: u16,
|
||||||
|
data_len: u16,
|
||||||
|
) -> Self {
|
||||||
|
Self::new_from_fields(PacketType::Tc, false, apid, seq_flags, seq_count, data_len)
|
||||||
}
|
}
|
||||||
|
|
||||||
//noinspection RsTraitImplementation
|
/// Variant of [SpHeader::new_for_tm_checked] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
||||||
delegate!(to self.packet_id {
|
#[inline]
|
||||||
/// Returns [false] and fails if the APID exceeds [MAX_APID]
|
pub fn new_for_unseg_tm_checked(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||||
pub fn set_apid(&mut self, apid: u16) -> bool;
|
Self::new_for_tm_checked(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||||
});
|
}
|
||||||
|
|
||||||
delegate!(to self.psc {
|
/// Variant of [SpHeader::new_for_tc_checked] which sets the sequence flag field to [SequenceFlags::Unsegmented]
|
||||||
/// Returns [false] and fails if the sequence count exceeds [MAX_SEQ_COUNT]
|
#[inline]
|
||||||
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
pub fn new_for_unseg_tc_checked(apid: u16, seq_count: u16, data_len: u16) -> Option<Self> {
|
||||||
});
|
Self::new_for_tc_checked(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 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.
|
||||||
|
#[inline]
|
||||||
|
pub const fn new_for_unseg_tc(apid: u16, seq_count: u16, data_len: u16) -> Self {
|
||||||
|
Self::new_for_tc(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// 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.
|
||||||
|
#[inline]
|
||||||
|
pub const fn new_for_unseg_tm(apid: u16, seq_count: u16, data_len: u16) -> Self {
|
||||||
|
Self::new_for_tm(apid, SequenceFlags::Unsegmented, seq_count, data_len)
|
||||||
|
}
|
||||||
|
|
||||||
|
delegate! {
|
||||||
|
to self.packet_id {
|
||||||
|
/// Returns [false] and fails if the APID exceeds [MAX_APID]
|
||||||
|
#[inline]
|
||||||
|
pub fn set_apid(&mut self, apid: u16) -> bool;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
delegate! {
|
||||||
|
to self.psc {
|
||||||
|
/// Returns [false] and fails if the sequence count exceeds [MAX_SEQ_COUNT]
|
||||||
|
#[inline]
|
||||||
|
pub fn set_seq_count(&mut self, seq_count: u16) -> bool;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn set_seq_flags(&mut self, seq_flags: SequenceFlags) {
|
pub fn set_seq_flags(&mut self, seq_flags: SequenceFlags) {
|
||||||
self.psc.seq_flags = seq_flags;
|
self.psc.seq_flags = seq_flags;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn set_sec_header_flag(&mut self) {
|
pub fn set_sec_header_flag(&mut self) {
|
||||||
self.packet_id.sec_header_flag = true;
|
self.packet_id.sec_header_flag = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn clear_sec_header_flag(&mut self) {
|
pub fn clear_sec_header_flag(&mut self) {
|
||||||
self.packet_id.sec_header_flag = false;
|
self.packet_id.sec_header_flag = false;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn set_packet_type(&mut self, packet_type: PacketType) {
|
pub fn set_packet_type(&mut self, packet_type: PacketType) {
|
||||||
self.packet_id.ptype = packet_type;
|
self.packet_id.ptype = packet_type;
|
||||||
}
|
}
|
||||||
|
@ -621,6 +755,15 @@ impl SpHeader {
|
||||||
.ok_or(ByteConversionError::ZeroCopyToError)?;
|
.ok_or(ByteConversionError::ZeroCopyToError)?;
|
||||||
Ok(&mut buf[CCSDS_HEADER_LEN..])
|
Ok(&mut buf[CCSDS_HEADER_LEN..])
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Create a vector containing the CCSDS header.
|
||||||
|
#[cfg(feature = "alloc")]
|
||||||
|
pub fn to_vec(&self) -> alloc::vec::Vec<u8> {
|
||||||
|
let mut vec = alloc::vec![0; CCSDS_HEADER_LEN];
|
||||||
|
// This can not fail.
|
||||||
|
self.write_to_be_bytes(&mut vec[..]).unwrap();
|
||||||
|
vec
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CcsdsPacket for SpHeader {
|
impl CcsdsPacket for SpHeader {
|
||||||
|
@ -646,6 +789,7 @@ impl CcsdsPacket for SpHeader {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl CcsdsPrimaryHeader for SpHeader {
|
impl CcsdsPrimaryHeader for SpHeader {
|
||||||
|
#[inline]
|
||||||
fn from_composite_fields(
|
fn from_composite_fields(
|
||||||
packet_id: PacketId,
|
packet_id: PacketId,
|
||||||
psc: PacketSequenceCtrl,
|
psc: PacketSequenceCtrl,
|
||||||
|
@ -713,9 +857,12 @@ pub mod zc {
|
||||||
((self.version_packet_id.get() >> 13) as u8) & 0b111
|
((self.version_packet_id.get() >> 13) as u8) & 0b111
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn packet_id(&self) -> PacketId {
|
fn packet_id(&self) -> PacketId {
|
||||||
PacketId::from(self.packet_id_raw())
|
PacketId::from(self.packet_id_raw())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn psc(&self) -> PacketSequenceCtrl {
|
fn psc(&self) -> PacketSequenceCtrl {
|
||||||
PacketSequenceCtrl::from(self.psc_raw())
|
PacketSequenceCtrl::from(self.psc_raw())
|
||||||
}
|
}
|
||||||
|
@ -725,10 +872,12 @@ pub mod zc {
|
||||||
self.data_len.get()
|
self.data_len.get()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn packet_id_raw(&self) -> u16 {
|
fn packet_id_raw(&self) -> u16 {
|
||||||
self.version_packet_id.get() & (!VERSION_MASK)
|
self.version_packet_id.get() & (!VERSION_MASK)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn psc_raw(&self) -> u16 {
|
fn psc_raw(&self) -> u16 {
|
||||||
self.psc.get()
|
self.psc.get()
|
||||||
}
|
}
|
||||||
|
@ -752,6 +901,8 @@ pub mod zc {
|
||||||
pub(crate) mod tests {
|
pub(crate) mod tests {
|
||||||
use std::collections::HashSet;
|
use std::collections::HashSet;
|
||||||
|
|
||||||
|
#[allow(unused_imports)]
|
||||||
|
use crate::ByteConversionError;
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use crate::CcsdsPrimaryHeader;
|
use crate::CcsdsPrimaryHeader;
|
||||||
use crate::{
|
use crate::{
|
||||||
|
@ -768,12 +919,12 @@ pub(crate) mod tests {
|
||||||
use serde::{de::DeserializeOwned, Serialize};
|
use serde::{de::DeserializeOwned, Serialize};
|
||||||
|
|
||||||
const CONST_SP: SpHeader = SpHeader::new(
|
const CONST_SP: SpHeader = SpHeader::new(
|
||||||
PacketId::const_tc(true, 0x36),
|
PacketId::new_for_tc(true, 0x36),
|
||||||
PacketSequenceCtrl::const_new(SequenceFlags::ContinuationSegment, 0x88),
|
PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 0x88),
|
||||||
0x90,
|
0x90,
|
||||||
);
|
);
|
||||||
|
|
||||||
const PACKET_ID_TM: PacketId = PacketId::const_tm(true, 0x22);
|
const PACKET_ID_TM: PacketId = PacketId::new_for_tm(true, 0x22);
|
||||||
|
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
pub(crate) fn generic_serde_test<T: Serialize + DeserializeOwned + PartialEq + Debug>(
|
pub(crate) fn generic_serde_test<T: Serialize + DeserializeOwned + PartialEq + Debug>(
|
||||||
|
@ -785,11 +936,12 @@ pub(crate) mod tests {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
#[allow(clippy::assertions_on_constants)]
|
||||||
fn verify_const_packet_id() {
|
fn verify_const_packet_id() {
|
||||||
assert_eq!(PACKET_ID_TM.apid(), 0x22);
|
assert_eq!(PACKET_ID_TM.apid(), 0x22);
|
||||||
assert!(PACKET_ID_TM.sec_header_flag);
|
assert!(PACKET_ID_TM.sec_header_flag);
|
||||||
assert_eq!(PACKET_ID_TM.ptype, PacketType::Tm);
|
assert_eq!(PACKET_ID_TM.ptype, PacketType::Tm);
|
||||||
let const_tc_id = PacketId::const_tc(true, 0x23);
|
let const_tc_id = PacketId::new_for_tc(true, 0x23);
|
||||||
assert_eq!(const_tc_id.ptype, PacketType::Tc);
|
assert_eq!(const_tc_id.ptype, PacketType::Tc);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -798,32 +950,32 @@ pub(crate) mod tests {
|
||||||
let id_default = PacketId::default();
|
let id_default = PacketId::default();
|
||||||
assert_eq!(id_default.ptype, PacketType::Tm);
|
assert_eq!(id_default.ptype, PacketType::Tm);
|
||||||
assert_eq!(id_default.apid, 0x000);
|
assert_eq!(id_default.apid, 0x000);
|
||||||
assert_eq!(id_default.sec_header_flag, false);
|
assert!(!id_default.sec_header_flag);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_packet_id_ctors() {
|
fn test_packet_id_ctors() {
|
||||||
let packet_id = PacketId::new(PacketType::Tc, true, 0x1ff);
|
let packet_id = PacketId::new_checked(PacketType::Tc, true, 0x1ff);
|
||||||
assert!(packet_id.is_some());
|
assert!(packet_id.is_some());
|
||||||
let packet_id = packet_id.unwrap();
|
let packet_id = packet_id.unwrap();
|
||||||
assert_eq!(packet_id.apid(), 0x1ff);
|
assert_eq!(packet_id.apid(), 0x1ff);
|
||||||
assert_eq!(packet_id.ptype, PacketType::Tc);
|
assert_eq!(packet_id.ptype, PacketType::Tc);
|
||||||
assert_eq!(packet_id.sec_header_flag, true);
|
assert!(packet_id.sec_header_flag);
|
||||||
let packet_id_tc = PacketId::tc(true, 0x1ff);
|
let packet_id_tc = PacketId::new_for_tc_checked(true, 0x1ff);
|
||||||
assert!(packet_id_tc.is_some());
|
assert!(packet_id_tc.is_some());
|
||||||
let packet_id_tc = packet_id_tc.unwrap();
|
let packet_id_tc = packet_id_tc.unwrap();
|
||||||
assert_eq!(packet_id_tc, packet_id);
|
assert_eq!(packet_id_tc, packet_id);
|
||||||
let packet_id_tm = PacketId::tm(true, 0x2ff);
|
let packet_id_tm = PacketId::new_for_tm_checked(true, 0x2ff);
|
||||||
assert!(packet_id_tm.is_some());
|
assert!(packet_id_tm.is_some());
|
||||||
let packet_id_tm = packet_id_tm.unwrap();
|
let packet_id_tm = packet_id_tm.unwrap();
|
||||||
assert_eq!(packet_id_tm.sec_header_flag, true);
|
assert!(packet_id_tm.sec_header_flag);
|
||||||
assert_eq!(packet_id_tm.ptype, PacketType::Tm);
|
assert_eq!(packet_id_tm.ptype, PacketType::Tm);
|
||||||
assert_eq!(packet_id_tm.apid, 0x2ff);
|
assert_eq!(packet_id_tm.apid, 0x2ff);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn verify_const_sp_header() {
|
fn verify_const_sp_header() {
|
||||||
assert_eq!(CONST_SP.sec_header_flag(), true);
|
assert!(CONST_SP.sec_header_flag());
|
||||||
assert_eq!(CONST_SP.apid(), 0x36);
|
assert_eq!(CONST_SP.apid(), 0x36);
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
CONST_SP.sequence_flags(),
|
CONST_SP.sequence_flags(),
|
||||||
|
@ -864,7 +1016,7 @@ pub(crate) mod tests {
|
||||||
#[test]
|
#[test]
|
||||||
fn test_packet_id() {
|
fn test_packet_id() {
|
||||||
let packet_id =
|
let packet_id =
|
||||||
PacketId::new(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
PacketId::new_checked(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
||||||
assert_eq!(packet_id.raw(), 0x0042);
|
assert_eq!(packet_id.raw(), 0x0042);
|
||||||
let packet_id_from_raw = PacketId::from(packet_id.raw());
|
let packet_id_from_raw = PacketId::from(packet_id.raw());
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
|
@ -872,26 +1024,26 @@ pub(crate) mod tests {
|
||||||
PacketType::Tm
|
PacketType::Tm
|
||||||
);
|
);
|
||||||
assert_eq!(packet_id_from_raw, packet_id);
|
assert_eq!(packet_id_from_raw, packet_id);
|
||||||
let packet_id_from_new = PacketId::new(PacketType::Tm, false, 0x42).unwrap();
|
let packet_id_from_new = PacketId::new_checked(PacketType::Tm, false, 0x42).unwrap();
|
||||||
assert_eq!(packet_id_from_new, packet_id);
|
assert_eq!(packet_id_from_new, packet_id);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_invalid_packet_id() {
|
fn test_invalid_packet_id() {
|
||||||
let packet_id_invalid = PacketId::new(PacketType::Tc, true, 0xFFFF);
|
let packet_id_invalid = PacketId::new_checked(PacketType::Tc, true, 0xFFFF);
|
||||||
assert!(packet_id_invalid.is_none());
|
assert!(packet_id_invalid.is_none());
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_invalid_apid_setter() {
|
fn test_invalid_apid_setter() {
|
||||||
let mut packet_id =
|
let mut packet_id =
|
||||||
PacketId::new(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
PacketId::new_checked(PacketType::Tm, false, 0x42).expect("Packet ID creation failed");
|
||||||
assert!(!packet_id.set_apid(0xffff));
|
assert!(!packet_id.set_apid(0xffff));
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_invalid_seq_count() {
|
fn test_invalid_seq_count() {
|
||||||
let mut psc = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77)
|
let mut psc = PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77)
|
||||||
.expect("PSC creation failed");
|
.expect("PSC creation failed");
|
||||||
assert_eq!(psc.seq_count(), 77);
|
assert_eq!(psc.seq_count(), 77);
|
||||||
assert!(!psc.set_seq_count(0xffff));
|
assert!(!psc.set_seq_count(0xffff));
|
||||||
|
@ -899,7 +1051,7 @@ pub(crate) mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_packet_seq_ctrl() {
|
fn test_packet_seq_ctrl() {
|
||||||
let mut psc = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77)
|
let mut psc = PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77)
|
||||||
.expect("PSC creation failed");
|
.expect("PSC creation failed");
|
||||||
assert_eq!(psc.raw(), 77);
|
assert_eq!(psc.raw(), 77);
|
||||||
let psc_from_raw = PacketSequenceCtrl::from(psc.raw());
|
let psc_from_raw = PacketSequenceCtrl::from(psc.raw());
|
||||||
|
@ -908,16 +1060,18 @@ pub(crate) mod tests {
|
||||||
assert!(!psc.set_seq_count(2u16.pow(15)));
|
assert!(!psc.set_seq_count(2u16.pow(15)));
|
||||||
assert_eq!(psc.raw(), 77);
|
assert_eq!(psc.raw(), 77);
|
||||||
|
|
||||||
let psc_invalid = PacketSequenceCtrl::new(SequenceFlags::FirstSegment, 0xFFFF);
|
let psc_invalid = PacketSequenceCtrl::new_checked(SequenceFlags::FirstSegment, 0xFFFF);
|
||||||
assert!(psc_invalid.is_none());
|
assert!(psc_invalid.is_none());
|
||||||
let psc_from_new = PacketSequenceCtrl::new(SequenceFlags::ContinuationSegment, 77).unwrap();
|
let psc_from_new =
|
||||||
|
PacketSequenceCtrl::new_checked(SequenceFlags::ContinuationSegment, 77).unwrap();
|
||||||
assert_eq!(psc_from_new, psc);
|
assert_eq!(psc_from_new, psc);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
fn test_serde_sph() {
|
fn test_serde_sph() {
|
||||||
let sp_header = SpHeader::tc_unseg(0x42, 12, 0).expect("Error creating SP header");
|
let sp_header =
|
||||||
|
SpHeader::new_for_unseg_tc_checked(0x42, 12, 0).expect("Error creating SP header");
|
||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
assert!(sp_header.is_tc());
|
assert!(sp_header.is_tc());
|
||||||
assert!(!sp_header.sec_header_flag());
|
assert!(!sp_header.sec_header_flag());
|
||||||
|
@ -939,7 +1093,8 @@ pub(crate) mod tests {
|
||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
assert_eq!(sp_header.data_len, 0);
|
assert_eq!(sp_header.data_len, 0);
|
||||||
|
|
||||||
let sp_header = SpHeader::tm_unseg(0x7, 22, 36).expect("Error creating SP header");
|
let sp_header =
|
||||||
|
SpHeader::new_for_unseg_tm_checked(0x7, 22, 36).expect("Error creating SP header");
|
||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
assert!(sp_header.is_tm());
|
assert!(sp_header.is_tm());
|
||||||
assert!(!sp_header.sec_header_flag());
|
assert!(!sp_header.sec_header_flag());
|
||||||
|
@ -953,8 +1108,8 @@ pub(crate) mod tests {
|
||||||
assert_eq!(sp_header.ccsds_version(), 0b000);
|
assert_eq!(sp_header.ccsds_version(), 0b000);
|
||||||
|
|
||||||
let from_comp_fields = SpHeader::from_composite_fields(
|
let from_comp_fields = SpHeader::from_composite_fields(
|
||||||
PacketId::new(PacketType::Tc, true, 0x42).unwrap(),
|
PacketId::new(PacketType::Tc, true, 0x42),
|
||||||
PacketSequenceCtrl::new(SequenceFlags::Unsegmented, 0x7).unwrap(),
|
PacketSequenceCtrl::new(SequenceFlags::Unsegmented, 0x7),
|
||||||
0,
|
0,
|
||||||
None,
|
None,
|
||||||
);
|
);
|
||||||
|
@ -971,7 +1126,7 @@ pub(crate) mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_setters() {
|
fn test_setters() {
|
||||||
let sp_header = SpHeader::tc(0x42, SequenceFlags::Unsegmented, 25, 0);
|
let sp_header = SpHeader::new_for_tc_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let mut sp_header = sp_header.unwrap();
|
let mut sp_header = sp_header.unwrap();
|
||||||
sp_header.set_apid(0x12);
|
sp_header.set_apid(0x12);
|
||||||
|
@ -989,7 +1144,7 @@ pub(crate) mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_tc_ctor() {
|
fn test_tc_ctor() {
|
||||||
let sp_header = SpHeader::tc(0x42, SequenceFlags::Unsegmented, 25, 0);
|
let sp_header = SpHeader::new_for_tc_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
verify_sp_fields(PacketType::Tc, &sp_header);
|
verify_sp_fields(PacketType::Tc, &sp_header);
|
||||||
|
@ -997,23 +1152,35 @@ pub(crate) mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_tc_ctor_unseg() {
|
fn test_tc_ctor_unseg() {
|
||||||
let sp_header = SpHeader::tc_unseg(0x42, 25, 0);
|
let sp_header = SpHeader::new_for_unseg_tc_checked(0x42, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
verify_sp_fields(PacketType::Tc, &sp_header);
|
verify_sp_fields(PacketType::Tc, &sp_header);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_tc_ctor_unseg_const() {
|
||||||
|
let sp_header = SpHeader::new_for_unseg_tc(0x42, 25, 0);
|
||||||
|
verify_sp_fields(PacketType::Tc, &sp_header);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_tm_ctor() {
|
fn test_tm_ctor() {
|
||||||
let sp_header = SpHeader::tm(0x42, SequenceFlags::Unsegmented, 25, 0);
|
let sp_header = SpHeader::new_for_tm_checked(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
verify_sp_fields(PacketType::Tm, &sp_header);
|
verify_sp_fields(PacketType::Tm, &sp_header);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_tm_ctor_const() {
|
||||||
|
let sp_header = SpHeader::new_for_tm(0x42, SequenceFlags::Unsegmented, 25, 0);
|
||||||
|
verify_sp_fields(PacketType::Tm, &sp_header);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_tm_ctor_unseg() {
|
fn test_tm_ctor_unseg() {
|
||||||
let sp_header = SpHeader::tm_unseg(0x42, 25, 0);
|
let sp_header = SpHeader::new_for_unseg_tm_checked(0x42, 25, 0);
|
||||||
assert!(sp_header.is_some());
|
assert!(sp_header.is_some());
|
||||||
let sp_header = sp_header.unwrap();
|
let sp_header = sp_header.unwrap();
|
||||||
verify_sp_fields(PacketType::Tm, &sp_header);
|
verify_sp_fields(PacketType::Tm, &sp_header);
|
||||||
|
@ -1031,8 +1198,8 @@ pub(crate) mod tests {
|
||||||
fn test_zc_sph() {
|
fn test_zc_sph() {
|
||||||
use zerocopy::AsBytes;
|
use zerocopy::AsBytes;
|
||||||
|
|
||||||
let sp_header =
|
let sp_header = SpHeader::new_for_unseg_tc_checked(0x7FF, pow(2, 14) - 1, 0)
|
||||||
SpHeader::tc_unseg(0x7FF, pow(2, 14) - 1, 0).expect("Error creating SP header");
|
.expect("Error creating SP header");
|
||||||
assert_eq!(sp_header.ptype(), PacketType::Tc);
|
assert_eq!(sp_header.ptype(), PacketType::Tc);
|
||||||
assert_eq!(sp_header.apid(), 0x7FF);
|
assert_eq!(sp_header.apid(), 0x7FF);
|
||||||
assert_eq!(sp_header.data_len(), 0);
|
assert_eq!(sp_header.data_len(), 0);
|
||||||
|
@ -1097,4 +1264,40 @@ pub(crate) mod tests {
|
||||||
let mut id_set = HashSet::new();
|
let mut id_set = HashSet::new();
|
||||||
id_set.insert(PacketId::from(1_u16));
|
id_set.insert(PacketId::from(1_u16));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sp_header_from_apid() {
|
||||||
|
let sp_header = SpHeader::new_from_apid(0x03);
|
||||||
|
assert_eq!(sp_header.apid(), 0x03);
|
||||||
|
assert_eq!(sp_header.data_len(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn sp_header_from_apid_checked() {
|
||||||
|
let sp_header = SpHeader::new_from_apid_checked(0x03).unwrap();
|
||||||
|
assert_eq!(sp_header.apid(), 0x03);
|
||||||
|
assert_eq!(sp_header.data_len(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "defmt")]
|
||||||
|
fn is_defmt_format<T: defmt::Format>(_t: T) {}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[cfg(feature = "defmt")]
|
||||||
|
fn test_defmt_format() {
|
||||||
|
is_defmt_format(ByteConversionError::ToSliceTooSmall {
|
||||||
|
found: 1,
|
||||||
|
expected: 2,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_sp_header_as_vec() {
|
||||||
|
let sp_header = SpHeader::new_for_unseg_tc(0x42, 25, 1);
|
||||||
|
let sp_header_as_vec = sp_header.to_vec();
|
||||||
|
let sp_header_read_back = SpHeader::from_be_bytes(&sp_header_as_vec)
|
||||||
|
.expect("Error reading back SP header")
|
||||||
|
.0;
|
||||||
|
assert_eq!(sp_header, sp_header_read_back);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -2,11 +2,8 @@
|
||||||
//! [CCSDS 301.0-B-4](https://public.ccsds.org/Pubs/301x0b4e1.pdf) section 3.5 .
|
//! [CCSDS 301.0-B-4](https://public.ccsds.org/Pubs/301x0b4e1.pdf) section 3.5 .
|
||||||
//! See [chrono::DateTime::format] for a usage example of the generated
|
//! See [chrono::DateTime::format] for a usage example of the generated
|
||||||
//! [chrono::format::DelayedFormat] structs.
|
//! [chrono::format::DelayedFormat] structs.
|
||||||
#[cfg(feature = "alloc")]
|
#[cfg(all(feature = "alloc", feature = "chrono"))]
|
||||||
use chrono::{
|
pub use alloc_mod_chrono::*;
|
||||||
format::{DelayedFormat, StrftimeItems},
|
|
||||||
DateTime, Utc,
|
|
||||||
};
|
|
||||||
|
|
||||||
/// Tuple of format string and formatted size for time code A.
|
/// Tuple of format string and formatted size for time code A.
|
||||||
///
|
///
|
||||||
|
@ -34,36 +31,37 @@ pub const FMT_STR_CODE_B_WITH_SIZE: (&str, usize) = ("%Y-%jT%T%.3f", 21);
|
||||||
/// Three digits are used for the decimal fraction and a terminator is added at the end.
|
/// Three digits are used for the decimal fraction and a terminator is added at the end.
|
||||||
pub const FMT_STR_CODE_B_TERMINATED_WITH_SIZE: (&str, usize) = ("%Y-%jT%T%.3fZ", 22);
|
pub const FMT_STR_CODE_B_TERMINATED_WITH_SIZE: (&str, usize) = ("%Y-%jT%T%.3fZ", 22);
|
||||||
|
|
||||||
/// Generates a time code formatter using the [FMT_STR_CODE_A_WITH_SIZE] format.
|
#[cfg(all(feature = "alloc", feature = "chrono"))]
|
||||||
#[cfg(feature = "alloc")]
|
pub mod alloc_mod_chrono {
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
|
use super::*;
|
||||||
pub fn generate_time_code_a(date: &DateTime<Utc>) -> DelayedFormat<StrftimeItems<'static>> {
|
use chrono::{
|
||||||
date.format(FMT_STR_CODE_A_WITH_SIZE.0)
|
format::{DelayedFormat, StrftimeItems},
|
||||||
}
|
DateTime, Utc,
|
||||||
|
};
|
||||||
|
|
||||||
/// Generates a time code formatter using the [FMT_STR_CODE_A_TERMINATED_WITH_SIZE] format.
|
/// Generates a time code formatter using the [FMT_STR_CODE_A_WITH_SIZE] format.
|
||||||
#[cfg(feature = "alloc")]
|
pub fn generate_time_code_a(date: &DateTime<Utc>) -> DelayedFormat<StrftimeItems<'static>> {
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
|
date.format(FMT_STR_CODE_A_WITH_SIZE.0)
|
||||||
pub fn generate_time_code_a_terminated(
|
}
|
||||||
date: &DateTime<Utc>,
|
|
||||||
) -> DelayedFormat<StrftimeItems<'static>> {
|
|
||||||
date.format(FMT_STR_CODE_A_TERMINATED_WITH_SIZE.0)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Generates a time code formatter using the [FMT_STR_CODE_B_WITH_SIZE] format.
|
/// Generates a time code formatter using the [FMT_STR_CODE_A_TERMINATED_WITH_SIZE] format.
|
||||||
#[cfg(feature = "alloc")]
|
pub fn generate_time_code_a_terminated(
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
|
date: &DateTime<Utc>,
|
||||||
pub fn generate_time_code_b(date: &DateTime<Utc>) -> DelayedFormat<StrftimeItems<'static>> {
|
) -> DelayedFormat<StrftimeItems<'static>> {
|
||||||
date.format(FMT_STR_CODE_B_WITH_SIZE.0)
|
date.format(FMT_STR_CODE_A_TERMINATED_WITH_SIZE.0)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Generates a time code formatter using the [FMT_STR_CODE_B_TERMINATED_WITH_SIZE] format.
|
/// Generates a time code formatter using the [FMT_STR_CODE_B_WITH_SIZE] format.
|
||||||
#[cfg(feature = "alloc")]
|
pub fn generate_time_code_b(date: &DateTime<Utc>) -> DelayedFormat<StrftimeItems<'static>> {
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]
|
date.format(FMT_STR_CODE_B_WITH_SIZE.0)
|
||||||
pub fn generate_time_code_b_terminated(
|
}
|
||||||
date: &DateTime<Utc>,
|
|
||||||
) -> DelayedFormat<StrftimeItems<'static>> {
|
/// Generates a time code formatter using the [FMT_STR_CODE_B_TERMINATED_WITH_SIZE] format.
|
||||||
date.format(FMT_STR_CODE_B_TERMINATED_WITH_SIZE.0)
|
pub fn generate_time_code_b_terminated(
|
||||||
|
date: &DateTime<Utc>,
|
||||||
|
) -> DelayedFormat<StrftimeItems<'static>> {
|
||||||
|
date.format(FMT_STR_CODE_B_TERMINATED_WITH_SIZE.0)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
|
@ -73,25 +71,54 @@ mod tests {
|
||||||
use std::format;
|
use std::format;
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ascii_timestamp_a_unterminated() {
|
fn test_ascii_timestamp_a_unterminated_epoch() {
|
||||||
let date = Utc::now();
|
let date = chrono::DateTime::UNIX_EPOCH;
|
||||||
let stamp_formatter = generate_time_code_a(&date);
|
let stamp_formatter = generate_time_code_a(&date);
|
||||||
let stamp = format!("{}", stamp_formatter);
|
let stamp = format!("{}", stamp_formatter);
|
||||||
let t_sep = stamp.find("T");
|
let t_sep = stamp.find('T');
|
||||||
assert!(t_sep.is_some());
|
assert!(t_sep.is_some());
|
||||||
assert_eq!(t_sep.unwrap(), 10);
|
assert_eq!(t_sep.unwrap(), 10);
|
||||||
assert_eq!(stamp.len(), FMT_STR_CODE_A_WITH_SIZE.1);
|
assert_eq!(stamp.len(), FMT_STR_CODE_A_WITH_SIZE.1);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ascii_timestamp_a_terminated() {
|
#[cfg_attr(miri, ignore)]
|
||||||
|
fn test_ascii_timestamp_a_unterminated_now() {
|
||||||
|
let date = Utc::now();
|
||||||
|
let stamp_formatter = generate_time_code_a(&date);
|
||||||
|
let stamp = format!("{}", stamp_formatter);
|
||||||
|
let t_sep = stamp.find('T');
|
||||||
|
assert!(t_sep.is_some());
|
||||||
|
assert_eq!(t_sep.unwrap(), 10);
|
||||||
|
assert_eq!(stamp.len(), FMT_STR_CODE_A_WITH_SIZE.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_ascii_timestamp_a_terminated_epoch() {
|
||||||
|
let date = chrono::DateTime::UNIX_EPOCH;
|
||||||
|
let stamp_formatter = generate_time_code_a_terminated(&date);
|
||||||
|
let stamp = format!("{}", stamp_formatter);
|
||||||
|
let t_sep = stamp.find('T');
|
||||||
|
assert!(t_sep.is_some());
|
||||||
|
assert_eq!(t_sep.unwrap(), 10);
|
||||||
|
let z_terminator = stamp.find('Z');
|
||||||
|
assert!(z_terminator.is_some());
|
||||||
|
assert_eq!(
|
||||||
|
z_terminator.unwrap(),
|
||||||
|
FMT_STR_CODE_A_TERMINATED_WITH_SIZE.1 - 1
|
||||||
|
);
|
||||||
|
assert_eq!(stamp.len(), FMT_STR_CODE_A_TERMINATED_WITH_SIZE.1);
|
||||||
|
}
|
||||||
|
#[test]
|
||||||
|
#[cfg_attr(miri, ignore)]
|
||||||
|
fn test_ascii_timestamp_a_terminated_now() {
|
||||||
let date = Utc::now();
|
let date = Utc::now();
|
||||||
let stamp_formatter = generate_time_code_a_terminated(&date);
|
let stamp_formatter = generate_time_code_a_terminated(&date);
|
||||||
let stamp = format!("{}", stamp_formatter);
|
let stamp = format!("{}", stamp_formatter);
|
||||||
let t_sep = stamp.find("T");
|
let t_sep = stamp.find('T');
|
||||||
assert!(t_sep.is_some());
|
assert!(t_sep.is_some());
|
||||||
assert_eq!(t_sep.unwrap(), 10);
|
assert_eq!(t_sep.unwrap(), 10);
|
||||||
let z_terminator = stamp.find("Z");
|
let z_terminator = stamp.find('Z');
|
||||||
assert!(z_terminator.is_some());
|
assert!(z_terminator.is_some());
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
z_terminator.unwrap(),
|
z_terminator.unwrap(),
|
||||||
|
@ -101,25 +128,55 @@ mod tests {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ascii_timestamp_b_unterminated() {
|
fn test_ascii_timestamp_b_unterminated_epoch() {
|
||||||
let date = Utc::now();
|
let date = chrono::DateTime::UNIX_EPOCH;
|
||||||
let stamp_formatter = generate_time_code_b(&date);
|
let stamp_formatter = generate_time_code_b(&date);
|
||||||
let stamp = format!("{}", stamp_formatter);
|
let stamp = format!("{}", stamp_formatter);
|
||||||
let t_sep = stamp.find("T");
|
let t_sep = stamp.find('T');
|
||||||
assert!(t_sep.is_some());
|
assert!(t_sep.is_some());
|
||||||
assert_eq!(t_sep.unwrap(), 8);
|
assert_eq!(t_sep.unwrap(), 8);
|
||||||
assert_eq!(stamp.len(), FMT_STR_CODE_B_WITH_SIZE.1);
|
assert_eq!(stamp.len(), FMT_STR_CODE_B_WITH_SIZE.1);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ascii_timestamp_b_terminated() {
|
#[cfg_attr(miri, ignore)]
|
||||||
|
fn test_ascii_timestamp_b_unterminated_now() {
|
||||||
|
let date = Utc::now();
|
||||||
|
let stamp_formatter = generate_time_code_b(&date);
|
||||||
|
let stamp = format!("{}", stamp_formatter);
|
||||||
|
let t_sep = stamp.find('T');
|
||||||
|
assert!(t_sep.is_some());
|
||||||
|
assert_eq!(t_sep.unwrap(), 8);
|
||||||
|
assert_eq!(stamp.len(), FMT_STR_CODE_B_WITH_SIZE.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_ascii_timestamp_b_terminated_epoch() {
|
||||||
|
let date = chrono::DateTime::UNIX_EPOCH;
|
||||||
|
let stamp_formatter = generate_time_code_b_terminated(&date);
|
||||||
|
let stamp = format!("{}", stamp_formatter);
|
||||||
|
let t_sep = stamp.find('T');
|
||||||
|
assert!(t_sep.is_some());
|
||||||
|
assert_eq!(t_sep.unwrap(), 8);
|
||||||
|
let z_terminator = stamp.find('Z');
|
||||||
|
assert!(z_terminator.is_some());
|
||||||
|
assert_eq!(
|
||||||
|
z_terminator.unwrap(),
|
||||||
|
FMT_STR_CODE_B_TERMINATED_WITH_SIZE.1 - 1
|
||||||
|
);
|
||||||
|
assert_eq!(stamp.len(), FMT_STR_CODE_B_TERMINATED_WITH_SIZE.1);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[cfg_attr(miri, ignore)]
|
||||||
|
fn test_ascii_timestamp_b_terminated_now() {
|
||||||
let date = Utc::now();
|
let date = Utc::now();
|
||||||
let stamp_formatter = generate_time_code_b_terminated(&date);
|
let stamp_formatter = generate_time_code_b_terminated(&date);
|
||||||
let stamp = format!("{}", stamp_formatter);
|
let stamp = format!("{}", stamp_formatter);
|
||||||
let t_sep = stamp.find("T");
|
let t_sep = stamp.find('T');
|
||||||
assert!(t_sep.is_some());
|
assert!(t_sep.is_some());
|
||||||
assert_eq!(t_sep.unwrap(), 8);
|
assert_eq!(t_sep.unwrap(), 8);
|
||||||
let z_terminator = stamp.find("Z");
|
let z_terminator = stamp.find('Z');
|
||||||
assert!(z_terminator.is_some());
|
assert!(z_terminator.is_some());
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
z_terminator.unwrap(),
|
z_terminator.unwrap(),
|
||||||
|
|
821
src/time/cds.rs
821
src/time/cds.rs
File diff suppressed because it is too large
Load Diff
944
src/time/cuc.rs
944
src/time/cuc.rs
File diff suppressed because it is too large
Load Diff
481
src/time/mod.rs
481
src/time/mod.rs
|
@ -1,9 +1,10 @@
|
||||||
//! CCSDS Time Code Formats according to [CCSDS 301.0-B-4](https://public.ccsds.org/Pubs/301x0b4e1.pdf)
|
//! CCSDS Time Code Formats according to [CCSDS 301.0-B-4](https://public.ccsds.org/Pubs/301x0b4e1.pdf)
|
||||||
use crate::ByteConversionError;
|
use crate::ByteConversionError;
|
||||||
use chrono::{DateTime, LocalResult, TimeZone, Utc};
|
#[cfg(feature = "chrono")]
|
||||||
|
use chrono::{TimeZone, Utc};
|
||||||
use core::cmp::Ordering;
|
use core::cmp::Ordering;
|
||||||
use core::fmt::{Display, Formatter};
|
use core::fmt::{Display, Formatter};
|
||||||
use core::ops::{Add, AddAssign};
|
use core::ops::{Add, AddAssign, Sub};
|
||||||
use core::time::Duration;
|
use core::time::Duration;
|
||||||
use core::u8;
|
use core::u8;
|
||||||
|
|
||||||
|
@ -13,6 +14,7 @@ use num_traits::float::FloatCore;
|
||||||
|
|
||||||
#[cfg(feature = "serde")]
|
#[cfg(feature = "serde")]
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
use std::error::Error;
|
use std::error::Error;
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
|
@ -27,10 +29,12 @@ pub mod cuc;
|
||||||
pub const DAYS_CCSDS_TO_UNIX: i32 = -4383;
|
pub const DAYS_CCSDS_TO_UNIX: i32 = -4383;
|
||||||
pub const SECONDS_PER_DAY: u32 = 86400;
|
pub const SECONDS_PER_DAY: u32 = 86400;
|
||||||
pub const MS_PER_DAY: u32 = SECONDS_PER_DAY * 1000;
|
pub const MS_PER_DAY: u32 = SECONDS_PER_DAY * 1000;
|
||||||
|
pub const NANOS_PER_SECOND: u32 = 1_000_000_000;
|
||||||
|
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
pub enum CcsdsTimeCodes {
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
|
pub enum CcsdsTimeCode {
|
||||||
CucCcsdsEpoch = 0b001,
|
CucCcsdsEpoch = 0b001,
|
||||||
CucAgencyEpoch = 0b010,
|
CucAgencyEpoch = 0b010,
|
||||||
Cds = 0b100,
|
Cds = 0b100,
|
||||||
|
@ -38,16 +42,16 @@ pub enum CcsdsTimeCodes {
|
||||||
AgencyDefined = 0b110,
|
AgencyDefined = 0b110,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl TryFrom<u8> for CcsdsTimeCodes {
|
impl TryFrom<u8> for CcsdsTimeCode {
|
||||||
type Error = ();
|
type Error = ();
|
||||||
|
|
||||||
fn try_from(value: u8) -> Result<Self, Self::Error> {
|
fn try_from(value: u8) -> Result<Self, Self::Error> {
|
||||||
match value {
|
match value {
|
||||||
x if x == CcsdsTimeCodes::CucCcsdsEpoch as u8 => Ok(CcsdsTimeCodes::CucCcsdsEpoch),
|
x if x == CcsdsTimeCode::CucCcsdsEpoch as u8 => Ok(CcsdsTimeCode::CucCcsdsEpoch),
|
||||||
x if x == CcsdsTimeCodes::CucAgencyEpoch as u8 => Ok(CcsdsTimeCodes::CucAgencyEpoch),
|
x if x == CcsdsTimeCode::CucAgencyEpoch as u8 => Ok(CcsdsTimeCode::CucAgencyEpoch),
|
||||||
x if x == CcsdsTimeCodes::Cds as u8 => Ok(CcsdsTimeCodes::Cds),
|
x if x == CcsdsTimeCode::Cds as u8 => Ok(CcsdsTimeCode::Cds),
|
||||||
x if x == CcsdsTimeCodes::Ccs as u8 => Ok(CcsdsTimeCodes::Ccs),
|
x if x == CcsdsTimeCode::Ccs as u8 => Ok(CcsdsTimeCode::Ccs),
|
||||||
x if x == CcsdsTimeCodes::AgencyDefined as u8 => Ok(CcsdsTimeCodes::AgencyDefined),
|
x if x == CcsdsTimeCode::AgencyDefined as u8 => Ok(CcsdsTimeCode::AgencyDefined),
|
||||||
_ => Err(()),
|
_ => Err(()),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -55,20 +59,34 @@ impl TryFrom<u8> for CcsdsTimeCodes {
|
||||||
|
|
||||||
/// Retrieve the CCSDS time code from the p-field. If no valid time code identifier is found, the
|
/// Retrieve the CCSDS time code from the p-field. If no valid time code identifier is found, the
|
||||||
/// value of the raw time code identification field is returned.
|
/// value of the raw time code identification field is returned.
|
||||||
pub fn ccsds_time_code_from_p_field(pfield: u8) -> Result<CcsdsTimeCodes, u8> {
|
pub fn ccsds_time_code_from_p_field(pfield: u8) -> Result<CcsdsTimeCode, u8> {
|
||||||
let raw_bits = (pfield >> 4) & 0b111;
|
let raw_bits = (pfield >> 4) & 0b111;
|
||||||
CcsdsTimeCodes::try_from(raw_bits).map_err(|_| raw_bits)
|
CcsdsTimeCode::try_from(raw_bits).map_err(|_| raw_bits)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
|
pub struct DateBeforeCcsdsEpochError(UnixTime);
|
||||||
|
|
||||||
|
impl Display for DateBeforeCcsdsEpochError {
|
||||||
|
fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
|
||||||
|
write!(f, "date before ccsds epoch: {:?}", self.0)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "std")]
|
||||||
|
impl Error for DateBeforeCcsdsEpochError {}
|
||||||
|
|
||||||
|
#[derive(Debug, PartialEq, Eq, Copy, Clone)]
|
||||||
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
#[non_exhaustive]
|
#[non_exhaustive]
|
||||||
pub enum TimestampError {
|
pub enum TimestampError {
|
||||||
InvalidTimeCode { expected: CcsdsTimeCodes, found: u8 },
|
InvalidTimeCode { expected: CcsdsTimeCode, found: u8 },
|
||||||
ByteConversion(ByteConversionError),
|
ByteConversion(ByteConversionError),
|
||||||
Cds(cds::CdsError),
|
Cds(cds::CdsError),
|
||||||
Cuc(cuc::CucError),
|
Cuc(cuc::CucError),
|
||||||
DateBeforeCcsdsEpoch(DateTime<Utc>),
|
|
||||||
CustomEpochNotSupported,
|
CustomEpochNotSupported,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -90,9 +108,6 @@ impl Display for TimestampError {
|
||||||
TimestampError::ByteConversion(e) => {
|
TimestampError::ByteConversion(e) => {
|
||||||
write!(f, "time stamp: {e}")
|
write!(f, "time stamp: {e}")
|
||||||
}
|
}
|
||||||
TimestampError::DateBeforeCcsdsEpoch(e) => {
|
|
||||||
write!(f, "datetime with date before ccsds epoch: {e}")
|
|
||||||
}
|
|
||||||
TimestampError::CustomEpochNotSupported => {
|
TimestampError::CustomEpochNotSupported => {
|
||||||
write!(f, "custom epochs are not supported")
|
write!(f, "custom epochs are not supported")
|
||||||
}
|
}
|
||||||
|
@ -111,6 +126,7 @@ impl Error for TimestampError {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<cds::CdsError> for TimestampError {
|
impl From<cds::CdsError> for TimestampError {
|
||||||
fn from(e: cds::CdsError) -> Self {
|
fn from(e: cds::CdsError) -> Self {
|
||||||
TimestampError::Cds(e)
|
TimestampError::Cds(e)
|
||||||
|
@ -124,7 +140,6 @@ impl From<cuc::CucError> for TimestampError {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "std")))]
|
|
||||||
pub mod std_mod {
|
pub mod std_mod {
|
||||||
use crate::time::TimestampError;
|
use crate::time::TimestampError;
|
||||||
use std::time::SystemTimeError;
|
use std::time::SystemTimeError;
|
||||||
|
@ -132,7 +147,7 @@ pub mod std_mod {
|
||||||
|
|
||||||
#[derive(Debug, Clone, Error)]
|
#[derive(Debug, Clone, Error)]
|
||||||
pub enum StdTimestampError {
|
pub enum StdTimestampError {
|
||||||
#[error("system time error: {0}")]
|
#[error("system time error: {0:?}")]
|
||||||
SystemTime(#[from] SystemTimeError),
|
SystemTime(#[from] SystemTimeError),
|
||||||
#[error("timestamp error: {0}")]
|
#[error("timestamp error: {0}")]
|
||||||
Timestamp(#[from] TimestampError),
|
Timestamp(#[from] TimestampError),
|
||||||
|
@ -140,7 +155,6 @@ pub mod std_mod {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "std")))]
|
|
||||||
pub fn seconds_since_epoch() -> f64 {
|
pub fn seconds_since_epoch() -> f64 {
|
||||||
SystemTime::now()
|
SystemTime::now()
|
||||||
.duration_since(SystemTime::UNIX_EPOCH)
|
.duration_since(SystemTime::UNIX_EPOCH)
|
||||||
|
@ -152,6 +166,7 @@ pub fn seconds_since_epoch() -> f64 {
|
||||||
///
|
///
|
||||||
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
||||||
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
||||||
|
#[inline]
|
||||||
pub const fn unix_to_ccsds_days(unix_days: i64) -> i64 {
|
pub const fn unix_to_ccsds_days(unix_days: i64) -> i64 {
|
||||||
unix_days - DAYS_CCSDS_TO_UNIX as i64
|
unix_days - DAYS_CCSDS_TO_UNIX as i64
|
||||||
}
|
}
|
||||||
|
@ -160,22 +175,24 @@ pub const fn unix_to_ccsds_days(unix_days: i64) -> i64 {
|
||||||
///
|
///
|
||||||
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
/// - CCSDS epoch: 1958-01-01T00:00:00+00:00
|
||||||
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
/// - UNIX Epoch: 1970-01-01T00:00:00+00:00
|
||||||
|
#[inline]
|
||||||
pub const fn ccsds_to_unix_days(ccsds_days: i64) -> i64 {
|
pub const fn ccsds_to_unix_days(ccsds_days: i64) -> i64 {
|
||||||
ccsds_days + DAYS_CCSDS_TO_UNIX as i64
|
ccsds_days + DAYS_CCSDS_TO_UNIX as i64
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Similar to [unix_to_ccsds_days] but converts the epoch instead, which is the number of elpased
|
/// Similar to [unix_to_ccsds_days] but converts the epoch instead, which is the number of elpased
|
||||||
/// seconds since the CCSDS and UNIX epoch times.
|
/// seconds since the CCSDS and UNIX epoch times.
|
||||||
|
#[inline]
|
||||||
pub const fn unix_epoch_to_ccsds_epoch(unix_epoch: i64) -> i64 {
|
pub const fn unix_epoch_to_ccsds_epoch(unix_epoch: i64) -> i64 {
|
||||||
unix_epoch - (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
unix_epoch - (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub const fn ccsds_epoch_to_unix_epoch(ccsds_epoch: i64) -> i64 {
|
pub const fn ccsds_epoch_to_unix_epoch(ccsds_epoch: i64) -> i64 {
|
||||||
ccsds_epoch + (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
ccsds_epoch + (DAYS_CCSDS_TO_UNIX as i64 * SECONDS_PER_DAY as i64)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[cfg(feature = "std")]
|
#[cfg(feature = "std")]
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "std")))]
|
|
||||||
pub fn ms_of_day_using_sysclock() -> u32 {
|
pub fn ms_of_day_using_sysclock() -> u32 {
|
||||||
ms_of_day(seconds_since_epoch())
|
ms_of_day(seconds_since_epoch())
|
||||||
}
|
}
|
||||||
|
@ -203,16 +220,15 @@ pub trait TimeWriter {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait TimeReader {
|
pub trait TimeReader: Sized {
|
||||||
fn from_bytes(buf: &[u8]) -> Result<Self, TimestampError>
|
fn from_bytes(buf: &[u8]) -> Result<Self, TimestampError>;
|
||||||
where
|
|
||||||
Self: Sized;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Trait for generic CCSDS time providers.
|
/// Trait for generic CCSDS time providers.
|
||||||
///
|
///
|
||||||
/// The UNIX helper methods and the [Self::date_time] method are not strictly necessary but extremely
|
/// The UNIX helper methods and the helper method are not strictly necessary but extremely
|
||||||
/// practical because they are a very common and simple exchange format for time information.
|
/// practical because they are a very common and simple exchange format for time information.
|
||||||
|
/// Therefore, it was decided to keep them in this trait as well.
|
||||||
pub trait CcsdsTimeProvider {
|
pub trait CcsdsTimeProvider {
|
||||||
fn len_as_bytes(&self) -> usize;
|
fn len_as_bytes(&self) -> usize;
|
||||||
|
|
||||||
|
@ -221,130 +237,203 @@ pub trait CcsdsTimeProvider {
|
||||||
/// entry denotes the length of the pfield and the second entry is the value of the pfield
|
/// entry denotes the length of the pfield and the second entry is the value of the pfield
|
||||||
/// in big endian format.
|
/// in big endian format.
|
||||||
fn p_field(&self) -> (usize, [u8; 2]);
|
fn p_field(&self) -> (usize, [u8; 2]);
|
||||||
fn ccdsd_time_code(&self) -> CcsdsTimeCodes;
|
fn ccdsd_time_code(&self) -> CcsdsTimeCode;
|
||||||
|
|
||||||
fn unix_seconds(&self) -> i64;
|
fn unix_secs(&self) -> i64;
|
||||||
fn subsecond_millis(&self) -> Option<u16>;
|
fn subsec_nanos(&self) -> u32;
|
||||||
fn unix_stamp(&self) -> UnixTimestamp {
|
|
||||||
if self.subsecond_millis().is_none() {
|
fn subsec_millis(&self) -> u16 {
|
||||||
return UnixTimestamp::new_only_seconds(self.unix_seconds());
|
(self.subsec_nanos() / 1_000_000) as u16
|
||||||
}
|
|
||||||
UnixTimestamp::const_new(self.unix_seconds(), self.subsecond_millis().unwrap())
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn date_time(&self) -> Option<DateTime<Utc>>;
|
fn unix_time(&self) -> UnixTime {
|
||||||
|
UnixTime::new(self.unix_secs(), self.subsec_nanos())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "chrono")]
|
||||||
|
fn chrono_date_time(&self) -> chrono::LocalResult<chrono::DateTime<chrono::Utc>> {
|
||||||
|
chrono::Utc.timestamp_opt(self.unix_secs(), self.subsec_nanos())
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "timelib")]
|
||||||
|
fn timelib_date_time(&self) -> Result<time::OffsetDateTime, time::error::ComponentRange> {
|
||||||
|
Ok(time::OffsetDateTime::from_unix_timestamp(self.unix_secs())?
|
||||||
|
+ time::Duration::nanoseconds(self.subsec_nanos().into()))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// UNIX timestamp: Elapsed seconds since 1970-01-01T00:00:00+00:00.
|
/// UNIX time: Elapsed non-leap seconds since 1970-01-01T00:00:00+00:00 UTC.
|
||||||
///
|
///
|
||||||
/// Also can optionally include subsecond millisecond for greater accuracy. Please note that a
|
/// This is a commonly used time format and can therefore also be used as a generic format to
|
||||||
/// subsecond millisecond value of 0 gets converted to [None].
|
/// convert other CCSDS time formats to and from. The subsecond precision is in nanoseconds
|
||||||
|
/// similarly to other common time formats and libraries.
|
||||||
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
pub struct UnixTimestamp {
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub unix_seconds: i64,
|
pub struct UnixTime {
|
||||||
subsecond_millis: Option<u16>,
|
secs: i64,
|
||||||
|
subsec_nanos: u32,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl UnixTimestamp {
|
impl UnixTime {
|
||||||
/// Returns none if the subsecond millisecond value is larger than 999. 0 is converted to
|
/// The UNIX epoch time: 1970-01-01T00:00:00+00:00 UTC.
|
||||||
/// a [None] value.
|
pub const EPOCH: Self = Self {
|
||||||
pub fn new(unix_seconds: i64, subsec_millis: u16) -> Option<Self> {
|
secs: 0,
|
||||||
if subsec_millis > 999 {
|
subsec_nanos: 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// The minimum possible `UnixTime`.
|
||||||
|
pub const MIN: Self = Self {
|
||||||
|
secs: i64::MIN,
|
||||||
|
subsec_nanos: 0,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// The maximum possible `UnixTime`.
|
||||||
|
pub const MAX: Self = Self {
|
||||||
|
secs: i64::MAX,
|
||||||
|
subsec_nanos: NANOS_PER_SECOND - 1,
|
||||||
|
};
|
||||||
|
|
||||||
|
/// Returns [None] if the subsecond nanosecond value is invalid (larger than fraction of a
|
||||||
|
/// second)
|
||||||
|
pub fn new_checked(unix_seconds: i64, subsec_nanos: u32) -> Option<Self> {
|
||||||
|
if subsec_nanos >= NANOS_PER_SECOND {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
Some(Self::const_new(unix_seconds, subsec_millis))
|
Some(Self::new(unix_seconds, subsec_nanos))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Like [Self::new] but const. Panics if the subsecond value is larger than 999.
|
/// Returns [None] if the subsecond millisecond value is invalid (larger than fraction of a
|
||||||
pub const fn const_new(unix_seconds: i64, subsec_millis: u16) -> Self {
|
/// second)
|
||||||
if subsec_millis > 999 {
|
pub fn new_subsec_millis_checked(unix_seconds: i64, subsec_millis: u16) -> Option<Self> {
|
||||||
panic!("subsec milliseconds exceeds 999");
|
if subsec_millis >= 1000 {
|
||||||
|
return None;
|
||||||
|
}
|
||||||
|
Self::new_checked(unix_seconds, subsec_millis as u32 * 1_000_000)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// This function will panic if the subsecond value is larger than the fraction of a second.
|
||||||
|
/// Use [Self::new_checked] if you want to handle this case without a panic.
|
||||||
|
pub const fn new(unix_seconds: i64, subsecond_nanos: u32) -> Self {
|
||||||
|
if subsecond_nanos >= NANOS_PER_SECOND {
|
||||||
|
panic!("invalid subsecond nanos value");
|
||||||
}
|
}
|
||||||
let subsecond_millis = if subsec_millis == 0 {
|
|
||||||
None
|
|
||||||
} else {
|
|
||||||
Some(subsec_millis)
|
|
||||||
};
|
|
||||||
Self {
|
Self {
|
||||||
unix_seconds,
|
secs: unix_seconds,
|
||||||
subsecond_millis,
|
subsec_nanos: subsecond_nanos,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn new_only_seconds(unix_seconds: i64) -> Self {
|
/// This function will panic if the subsecond value is larger than the fraction of a second.
|
||||||
|
/// Use [Self::new_subsec_millis_checked] if you want to handle this case without a panic.
|
||||||
|
pub const fn new_subsec_millis(unix_seconds: i64, subsecond_millis: u16) -> Self {
|
||||||
|
if subsecond_millis >= 1000 {
|
||||||
|
panic!("invalid subsecond millisecond value");
|
||||||
|
}
|
||||||
Self {
|
Self {
|
||||||
unix_seconds,
|
secs: unix_seconds,
|
||||||
subsecond_millis: None,
|
subsec_nanos: subsecond_millis as u32 * 1_000_000,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn subsecond_millis(&self) -> Option<u16> {
|
pub fn new_only_secs(unix_seconds: i64) -> Self {
|
||||||
self.subsecond_millis
|
Self {
|
||||||
}
|
secs: unix_seconds,
|
||||||
|
subsec_nanos: 0,
|
||||||
#[cfg(feature = "std")]
|
}
|
||||||
#[cfg_attr(doc_cfg, doc(cfg(feature = "std")))]
|
|
||||||
pub fn from_now() -> Result<Self, SystemTimeError> {
|
|
||||||
let now = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?;
|
|
||||||
let epoch = now.as_secs();
|
|
||||||
Ok(Self::const_new(epoch as i64, now.subsec_millis() as u16))
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[inline]
|
#[inline]
|
||||||
pub fn unix_seconds_f64(&self) -> f64 {
|
pub fn subsec_millis(&self) -> u16 {
|
||||||
let mut secs = self.unix_seconds as f64;
|
(self.subsec_nanos / 1_000_000) as u16
|
||||||
if let Some(subsec_millis) = self.subsecond_millis {
|
|
||||||
secs += subsec_millis as f64 / 1000.0;
|
|
||||||
}
|
|
||||||
secs
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn as_date_time(&self) -> LocalResult<DateTime<Utc>> {
|
pub fn subsec_nanos(&self) -> u32 {
|
||||||
Utc.timestamp_opt(
|
self.subsec_nanos
|
||||||
self.unix_seconds,
|
}
|
||||||
self.subsecond_millis.unwrap_or(0) as u32 * 10_u32.pow(6),
|
|
||||||
)
|
#[cfg(feature = "std")]
|
||||||
|
pub fn now() -> Result<Self, SystemTimeError> {
|
||||||
|
let now = SystemTime::now().duration_since(SystemTime::UNIX_EPOCH)?;
|
||||||
|
let epoch = now.as_secs();
|
||||||
|
Ok(Self::new(epoch as i64, now.subsec_nanos()))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
pub fn unix_secs_f64(&self) -> f64 {
|
||||||
|
self.secs as f64 + (self.subsec_nanos as f64 / 1_000_000_000.0)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn as_secs(&self) -> i64 {
|
||||||
|
self.secs
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "chrono")]
|
||||||
|
pub fn chrono_date_time(&self) -> chrono::LocalResult<chrono::DateTime<chrono::Utc>> {
|
||||||
|
Utc.timestamp_opt(self.secs, self.subsec_nanos)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(feature = "timelib")]
|
||||||
|
pub fn timelib_date_time(&self) -> Result<time::OffsetDateTime, time::error::ComponentRange> {
|
||||||
|
Ok(time::OffsetDateTime::from_unix_timestamp(self.as_secs())?
|
||||||
|
+ time::Duration::nanoseconds(self.subsec_nanos().into()))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Calculate the difference in milliseconds between two UnixTimestamps
|
||||||
|
pub fn diff_in_millis(&self, other: &UnixTime) -> Option<i64> {
|
||||||
|
let seconds_difference = self.secs.checked_sub(other.secs)?;
|
||||||
|
// Convert seconds difference to milliseconds
|
||||||
|
let milliseconds_difference = seconds_difference.checked_mul(1000)?;
|
||||||
|
|
||||||
|
// Calculate the difference in subsecond milliseconds directly
|
||||||
|
let subsecond_difference_nanos = self.subsec_nanos as i64 - other.subsec_nanos as i64;
|
||||||
|
|
||||||
|
// Combine the differences
|
||||||
|
Some(milliseconds_difference + (subsecond_difference_nanos / 1_000_000))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<DateTime<Utc>> for UnixTimestamp {
|
#[cfg(feature = "chrono")]
|
||||||
fn from(value: DateTime<Utc>) -> Self {
|
impl From<chrono::DateTime<chrono::Utc>> for UnixTime {
|
||||||
Self::const_new(value.timestamp(), value.timestamp_subsec_millis() as u16)
|
fn from(value: chrono::DateTime<chrono::Utc>) -> Self {
|
||||||
|
Self::new(value.timestamp(), value.timestamp_subsec_nanos())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl PartialOrd for UnixTimestamp {
|
#[cfg(feature = "timelib")]
|
||||||
|
impl From<time::OffsetDateTime> for UnixTime {
|
||||||
|
fn from(value: time::OffsetDateTime) -> Self {
|
||||||
|
Self::new(value.unix_timestamp(), value.nanosecond())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl PartialOrd for UnixTime {
|
||||||
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
|
fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
|
||||||
Some(self.cmp(other))
|
Some(self.cmp(other))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Ord for UnixTimestamp {
|
impl Ord for UnixTime {
|
||||||
fn cmp(&self, other: &Self) -> Ordering {
|
fn cmp(&self, other: &Self) -> Ordering {
|
||||||
if self == other {
|
if self == other {
|
||||||
return Ordering::Equal;
|
return Ordering::Equal;
|
||||||
}
|
}
|
||||||
match self.unix_seconds.cmp(&other.unix_seconds) {
|
match self.secs.cmp(&other.secs) {
|
||||||
Ordering::Less => return Ordering::Less,
|
Ordering::Less => return Ordering::Less,
|
||||||
Ordering::Greater => return Ordering::Greater,
|
Ordering::Greater => return Ordering::Greater,
|
||||||
_ => (),
|
_ => (),
|
||||||
}
|
}
|
||||||
|
|
||||||
match self
|
match self.subsec_millis().cmp(&other.subsec_millis()) {
|
||||||
.subsecond_millis()
|
|
||||||
.unwrap_or(0)
|
|
||||||
.cmp(&other.subsecond_millis().unwrap_or(0))
|
|
||||||
{
|
|
||||||
Ordering::Less => {
|
Ordering::Less => {
|
||||||
return if self.unix_seconds < 0 {
|
return if self.secs < 0 {
|
||||||
Ordering::Greater
|
Ordering::Greater
|
||||||
} else {
|
} else {
|
||||||
Ordering::Less
|
Ordering::Less
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
Ordering::Greater => {
|
Ordering::Greater => {
|
||||||
return if self.unix_seconds < 0 {
|
return if self.secs < 0 {
|
||||||
Ordering::Less
|
Ordering::Less
|
||||||
} else {
|
} else {
|
||||||
Ordering::Greater
|
Ordering::Greater
|
||||||
|
@ -356,13 +445,36 @@ impl Ord for UnixTimestamp {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn get_new_stamp_after_addition(
|
/// Difference between two UNIX timestamps. The [Duration] type can not contain negative durations,
|
||||||
current_stamp: &UnixTimestamp,
|
/// so the sign information is supplied separately.
|
||||||
duration: Duration,
|
#[derive(Clone, Copy, PartialEq, Eq)]
|
||||||
) -> UnixTimestamp {
|
pub struct StampDiff {
|
||||||
let mut new_subsec_millis =
|
pub positive_duration: bool,
|
||||||
current_stamp.subsecond_millis().unwrap_or(0) + duration.subsec_millis() as u16;
|
pub duration_absolute: Duration,
|
||||||
let mut new_unix_seconds = current_stamp.unix_seconds;
|
}
|
||||||
|
|
||||||
|
impl Sub for UnixTime {
|
||||||
|
type Output = Option<StampDiff>;
|
||||||
|
|
||||||
|
fn sub(self, rhs: Self) -> Self::Output {
|
||||||
|
let difference = self.diff_in_millis(&rhs)?;
|
||||||
|
Some(if difference < 0 {
|
||||||
|
StampDiff {
|
||||||
|
positive_duration: false,
|
||||||
|
duration_absolute: Duration::from_millis(-difference as u64),
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
StampDiff {
|
||||||
|
positive_duration: true,
|
||||||
|
duration_absolute: Duration::from_millis(difference as u64),
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_new_stamp_after_addition(current_stamp: &UnixTime, duration: Duration) -> UnixTime {
|
||||||
|
let mut new_subsec_nanos = current_stamp.subsec_nanos() + duration.subsec_nanos();
|
||||||
|
let mut new_unix_seconds = current_stamp.secs;
|
||||||
let mut increment_seconds = |value: u32| {
|
let mut increment_seconds = |value: u32| {
|
||||||
if new_unix_seconds < 0 {
|
if new_unix_seconds < 0 {
|
||||||
new_unix_seconds = new_unix_seconds
|
new_unix_seconds = new_unix_seconds
|
||||||
|
@ -374,8 +486,8 @@ fn get_new_stamp_after_addition(
|
||||||
.expect("new unix seconds would exceed i64::MAX");
|
.expect("new unix seconds would exceed i64::MAX");
|
||||||
}
|
}
|
||||||
};
|
};
|
||||||
if new_subsec_millis >= 1000 {
|
if new_subsec_nanos >= 1_000_000_000 {
|
||||||
new_subsec_millis -= 1000;
|
new_subsec_nanos -= 1_000_000_000;
|
||||||
increment_seconds(1);
|
increment_seconds(1);
|
||||||
}
|
}
|
||||||
increment_seconds(
|
increment_seconds(
|
||||||
|
@ -384,7 +496,7 @@ fn get_new_stamp_after_addition(
|
||||||
.try_into()
|
.try_into()
|
||||||
.expect("duration seconds exceeds u32::MAX"),
|
.expect("duration seconds exceeds u32::MAX"),
|
||||||
);
|
);
|
||||||
UnixTimestamp::const_new(new_unix_seconds, new_subsec_millis)
|
UnixTime::new(new_unix_seconds, new_subsec_nanos)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Please note that this operation will panic on the following conditions:
|
/// Please note that this operation will panic on the following conditions:
|
||||||
|
@ -392,7 +504,7 @@ fn get_new_stamp_after_addition(
|
||||||
/// - Unix seconds after subtraction for stamps before the unix epoch exceeds [i64::MIN].
|
/// - Unix seconds after subtraction for stamps before the unix epoch exceeds [i64::MIN].
|
||||||
/// - Unix seconds after addition exceeds [i64::MAX].
|
/// - Unix seconds after addition exceeds [i64::MAX].
|
||||||
/// - Seconds from duration to add exceeds [u32::MAX].
|
/// - Seconds from duration to add exceeds [u32::MAX].
|
||||||
impl AddAssign<Duration> for UnixTimestamp {
|
impl AddAssign<Duration> for UnixTime {
|
||||||
fn add_assign(&mut self, duration: Duration) {
|
fn add_assign(&mut self, duration: Duration) {
|
||||||
*self = get_new_stamp_after_addition(self, duration);
|
*self = get_new_stamp_after_addition(self, duration);
|
||||||
}
|
}
|
||||||
|
@ -403,7 +515,7 @@ impl AddAssign<Duration> for UnixTimestamp {
|
||||||
/// - Unix seconds after subtraction for stamps before the unix epoch exceeds [i64::MIN].
|
/// - Unix seconds after subtraction for stamps before the unix epoch exceeds [i64::MIN].
|
||||||
/// - Unix seconds after addition exceeds [i64::MAX].
|
/// - Unix seconds after addition exceeds [i64::MAX].
|
||||||
/// - Unix seconds exceeds [u32::MAX].
|
/// - Unix seconds exceeds [u32::MAX].
|
||||||
impl Add<Duration> for UnixTimestamp {
|
impl Add<Duration> for UnixTime {
|
||||||
type Output = Self;
|
type Output = Self;
|
||||||
|
|
||||||
fn add(self, duration: Duration) -> Self::Output {
|
fn add(self, duration: Duration) -> Self::Output {
|
||||||
|
@ -411,8 +523,8 @@ impl Add<Duration> for UnixTimestamp {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Add<Duration> for &UnixTimestamp {
|
impl Add<Duration> for &UnixTime {
|
||||||
type Output = UnixTimestamp;
|
type Output = UnixTime;
|
||||||
|
|
||||||
fn add(self, duration: Duration) -> Self::Output {
|
fn add(self, duration: Duration) -> Self::Output {
|
||||||
get_new_stamp_after_addition(self, duration)
|
get_new_stamp_after_addition(self, duration)
|
||||||
|
@ -423,10 +535,15 @@ impl Add<Duration> for &UnixTimestamp {
|
||||||
mod tests {
|
mod tests {
|
||||||
use alloc::string::ToString;
|
use alloc::string::ToString;
|
||||||
use chrono::{Datelike, Timelike};
|
use chrono::{Datelike, Timelike};
|
||||||
use std::format;
|
use std::{format, println};
|
||||||
|
|
||||||
use super::{cuc::CucError, *};
|
use super::{cuc::CucError, *};
|
||||||
|
|
||||||
|
#[allow(dead_code)]
|
||||||
|
const UNIX_STAMP_CONST: UnixTime = UnixTime::new(5, 999_999_999);
|
||||||
|
#[allow(dead_code)]
|
||||||
|
const UNIX_STAMP_CONST_2: UnixTime = UnixTime::new_subsec_millis(5, 999);
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_days_conversion() {
|
fn test_days_conversion() {
|
||||||
assert_eq!(unix_to_ccsds_days(DAYS_CCSDS_TO_UNIX.into()), 0);
|
assert_eq!(unix_to_ccsds_days(DAYS_CCSDS_TO_UNIX.into()), 0);
|
||||||
|
@ -434,6 +551,7 @@ mod tests {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
#[cfg_attr(miri, ignore)]
|
||||||
fn test_get_current_time() {
|
fn test_get_current_time() {
|
||||||
let sec_floats = seconds_since_epoch();
|
let sec_floats = seconds_since_epoch();
|
||||||
assert!(sec_floats > 0.0);
|
assert!(sec_floats > 0.0);
|
||||||
|
@ -448,6 +566,7 @@ mod tests {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
#[cfg_attr(miri, ignore)]
|
||||||
fn test_ccsds_epoch() {
|
fn test_ccsds_epoch() {
|
||||||
let now = SystemTime::now()
|
let now = SystemTime::now()
|
||||||
.duration_since(SystemTime::UNIX_EPOCH)
|
.duration_since(SystemTime::UNIX_EPOCH)
|
||||||
|
@ -462,29 +581,29 @@ mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn basic_unix_stamp_test() {
|
fn basic_unix_stamp_test() {
|
||||||
let stamp = UnixTimestamp::new_only_seconds(-200);
|
let stamp = UnixTime::new_only_secs(-200);
|
||||||
assert_eq!(stamp.unix_seconds, -200);
|
assert_eq!(stamp.secs, -200);
|
||||||
assert!(stamp.subsecond_millis().is_none());
|
assert_eq!(stamp.subsec_millis(), 0);
|
||||||
let stamp = UnixTimestamp::new_only_seconds(250);
|
let stamp = UnixTime::new_only_secs(250);
|
||||||
assert_eq!(stamp.unix_seconds, 250);
|
assert_eq!(stamp.secs, 250);
|
||||||
assert!(stamp.subsecond_millis().is_none());
|
assert_eq!(stamp.subsec_millis(), 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn basic_float_unix_stamp_test() {
|
fn basic_float_unix_stamp_test() {
|
||||||
let stamp = UnixTimestamp::new(500, 600).unwrap();
|
let stamp = UnixTime::new_subsec_millis_checked(500, 600).unwrap();
|
||||||
assert!(stamp.subsecond_millis.is_some());
|
assert_eq!(stamp.secs, 500);
|
||||||
assert_eq!(stamp.unix_seconds, 500);
|
let subsec_millis = stamp.subsec_millis();
|
||||||
let subsec_millis = stamp.subsecond_millis().unwrap();
|
|
||||||
assert_eq!(subsec_millis, 600);
|
assert_eq!(subsec_millis, 600);
|
||||||
assert!((500.6 - stamp.unix_seconds_f64()).abs() < 0.0001);
|
println!("{:?}", (500.6 - stamp.unix_secs_f64()).to_string());
|
||||||
|
assert!((500.6 - stamp.unix_secs_f64()).abs() < 0.0001);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ord_larger() {
|
fn test_ord_larger() {
|
||||||
let stamp0 = UnixTimestamp::new_only_seconds(5);
|
let stamp0 = UnixTime::new_only_secs(5);
|
||||||
let stamp1 = UnixTimestamp::new(5, 500).unwrap();
|
let stamp1 = UnixTime::new_subsec_millis_checked(5, 500).unwrap();
|
||||||
let stamp2 = UnixTimestamp::new_only_seconds(6);
|
let stamp2 = UnixTime::new_only_secs(6);
|
||||||
assert!(stamp1 > stamp0);
|
assert!(stamp1 > stamp0);
|
||||||
assert!(stamp2 > stamp0);
|
assert!(stamp2 > stamp0);
|
||||||
assert!(stamp2 > stamp1);
|
assert!(stamp2 > stamp1);
|
||||||
|
@ -492,9 +611,9 @@ mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ord_smaller() {
|
fn test_ord_smaller() {
|
||||||
let stamp0 = UnixTimestamp::new_only_seconds(5);
|
let stamp0 = UnixTime::new_only_secs(5);
|
||||||
let stamp1 = UnixTimestamp::new(5, 500).unwrap();
|
let stamp1 = UnixTime::new_subsec_millis_checked(5, 500).unwrap();
|
||||||
let stamp2 = UnixTimestamp::new_only_seconds(6);
|
let stamp2 = UnixTime::new_only_secs(6);
|
||||||
assert!(stamp0 < stamp1);
|
assert!(stamp0 < stamp1);
|
||||||
assert!(stamp0 < stamp2);
|
assert!(stamp0 < stamp2);
|
||||||
assert!(stamp1 < stamp2);
|
assert!(stamp1 < stamp2);
|
||||||
|
@ -502,9 +621,9 @@ mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ord_larger_neg_numbers() {
|
fn test_ord_larger_neg_numbers() {
|
||||||
let stamp0 = UnixTimestamp::new_only_seconds(-5);
|
let stamp0 = UnixTime::new_only_secs(-5);
|
||||||
let stamp1 = UnixTimestamp::new(-5, 500).unwrap();
|
let stamp1 = UnixTime::new_subsec_millis_checked(-5, 500).unwrap();
|
||||||
let stamp2 = UnixTimestamp::new_only_seconds(-6);
|
let stamp2 = UnixTime::new_only_secs(-6);
|
||||||
assert!(stamp0 > stamp1);
|
assert!(stamp0 > stamp1);
|
||||||
assert!(stamp0 > stamp2);
|
assert!(stamp0 > stamp2);
|
||||||
assert!(stamp1 > stamp2);
|
assert!(stamp1 > stamp2);
|
||||||
|
@ -514,9 +633,9 @@ mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_ord_smaller_neg_numbers() {
|
fn test_ord_smaller_neg_numbers() {
|
||||||
let stamp0 = UnixTimestamp::new_only_seconds(-5);
|
let stamp0 = UnixTime::new_only_secs(-5);
|
||||||
let stamp1 = UnixTimestamp::new(-5, 500).unwrap();
|
let stamp1 = UnixTime::new_subsec_millis_checked(-5, 500).unwrap();
|
||||||
let stamp2 = UnixTimestamp::new_only_seconds(-6);
|
let stamp2 = UnixTime::new_only_secs(-6);
|
||||||
assert!(stamp2 < stamp1);
|
assert!(stamp2 < stamp1);
|
||||||
assert!(stamp2 < stamp0);
|
assert!(stamp2 < stamp0);
|
||||||
assert!(stamp1 < stamp0);
|
assert!(stamp1 < stamp0);
|
||||||
|
@ -524,10 +643,11 @@ mod tests {
|
||||||
assert!(stamp2 <= stamp1);
|
assert!(stamp2 <= stamp1);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::nonminimal_bool)]
|
||||||
#[test]
|
#[test]
|
||||||
fn test_eq() {
|
fn test_eq() {
|
||||||
let stamp0 = UnixTimestamp::new(5, 0).unwrap();
|
let stamp0 = UnixTime::new(5, 0);
|
||||||
let stamp1 = UnixTimestamp::new_only_seconds(5);
|
let stamp1 = UnixTime::new_only_secs(5);
|
||||||
assert_eq!(stamp0, stamp1);
|
assert_eq!(stamp0, stamp1);
|
||||||
assert!(stamp0 <= stamp1);
|
assert!(stamp0 <= stamp1);
|
||||||
assert!(stamp0 >= stamp1);
|
assert!(stamp0 >= stamp1);
|
||||||
|
@ -537,28 +657,27 @@ mod tests {
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_addition() {
|
fn test_addition() {
|
||||||
let mut stamp0 = UnixTimestamp::new_only_seconds(1);
|
let mut stamp0 = UnixTime::new_only_secs(1);
|
||||||
stamp0 += Duration::from_secs(5);
|
stamp0 += Duration::from_secs(5);
|
||||||
assert_eq!(stamp0.unix_seconds, 6);
|
assert_eq!(stamp0.as_secs(), 6);
|
||||||
assert!(stamp0.subsecond_millis().is_none());
|
assert_eq!(stamp0.subsec_millis(), 0);
|
||||||
let stamp1 = stamp0 + Duration::from_millis(500);
|
let stamp1 = stamp0 + Duration::from_millis(500);
|
||||||
assert_eq!(stamp1.unix_seconds, 6);
|
assert_eq!(stamp1.secs, 6);
|
||||||
assert!(stamp1.subsecond_millis().is_some());
|
assert_eq!(stamp1.subsec_millis(), 500);
|
||||||
assert_eq!(stamp1.subsecond_millis().unwrap(), 500);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_addition_on_ref() {
|
fn test_addition_on_ref() {
|
||||||
let stamp0 = &UnixTimestamp::new(20, 500).unwrap();
|
let stamp0 = &UnixTime::new_subsec_millis_checked(20, 500).unwrap();
|
||||||
let stamp1 = stamp0 + Duration::from_millis(2500);
|
let stamp1 = stamp0 + Duration::from_millis(2500);
|
||||||
assert_eq!(stamp1.unix_seconds, 23);
|
assert_eq!(stamp1.secs, 23);
|
||||||
assert!(stamp1.subsecond_millis().is_none());
|
assert_eq!(stamp1.subsec_millis(), 0);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_as_dt() {
|
fn test_as_dt() {
|
||||||
let stamp = UnixTimestamp::new_only_seconds(0);
|
let stamp = UnixTime::new_only_secs(0);
|
||||||
let dt = stamp.as_date_time().unwrap();
|
let dt = stamp.chrono_date_time().unwrap();
|
||||||
assert_eq!(dt.year(), 1970);
|
assert_eq!(dt.year(), 1970);
|
||||||
assert_eq!(dt.month(), 1);
|
assert_eq!(dt.month(), 1);
|
||||||
assert_eq!(dt.day(), 1);
|
assert_eq!(dt.day(), 1);
|
||||||
|
@ -568,21 +687,57 @@ mod tests {
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
#[cfg_attr(miri, ignore)]
|
||||||
fn test_from_now() {
|
fn test_from_now() {
|
||||||
let stamp_now = UnixTimestamp::from_now().unwrap();
|
let stamp_now = UnixTime::now().unwrap();
|
||||||
let dt_now = stamp_now.as_date_time().unwrap();
|
let dt_now = stamp_now.chrono_date_time().unwrap();
|
||||||
assert!(dt_now.year() >= 2020);
|
assert!(dt_now.year() >= 2020);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_stamp_diff_positive_0() {
|
||||||
|
let stamp_later = UnixTime::new(2, 0);
|
||||||
|
let StampDiff {
|
||||||
|
positive_duration,
|
||||||
|
duration_absolute,
|
||||||
|
} = (stamp_later - UnixTime::new(1, 0)).expect("stamp diff error");
|
||||||
|
assert!(positive_duration);
|
||||||
|
assert_eq!(duration_absolute, Duration::from_secs(1));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_stamp_diff_positive_1() {
|
||||||
|
let stamp_later = UnixTime::new(3, 800 * 1_000_000);
|
||||||
|
let stamp_earlier = UnixTime::new_subsec_millis_checked(1, 900).unwrap();
|
||||||
|
let StampDiff {
|
||||||
|
positive_duration,
|
||||||
|
duration_absolute,
|
||||||
|
} = (stamp_later - stamp_earlier).expect("stamp diff error");
|
||||||
|
assert!(positive_duration);
|
||||||
|
assert_eq!(duration_absolute, Duration::from_millis(1900));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_stamp_diff_negative() {
|
||||||
|
let stamp_later = UnixTime::new_subsec_millis_checked(3, 800).unwrap();
|
||||||
|
let stamp_earlier = UnixTime::new_subsec_millis_checked(1, 900).unwrap();
|
||||||
|
let StampDiff {
|
||||||
|
positive_duration,
|
||||||
|
duration_absolute,
|
||||||
|
} = (stamp_earlier - stamp_later).expect("stamp diff error");
|
||||||
|
assert!(!positive_duration);
|
||||||
|
assert_eq!(duration_absolute, Duration::from_millis(1900));
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_addition_spillover() {
|
fn test_addition_spillover() {
|
||||||
let mut stamp0 = UnixTimestamp::new(1, 900).unwrap();
|
let mut stamp0 = UnixTime::new_subsec_millis_checked(1, 900).unwrap();
|
||||||
stamp0 += Duration::from_millis(100);
|
stamp0 += Duration::from_millis(100);
|
||||||
assert_eq!(stamp0.unix_seconds, 2);
|
assert_eq!(stamp0.secs, 2);
|
||||||
assert!(stamp0.subsecond_millis().is_none());
|
assert_eq!(stamp0.subsec_millis(), 0);
|
||||||
stamp0 += Duration::from_millis(1100);
|
stamp0 += Duration::from_millis(1100);
|
||||||
assert_eq!(stamp0.unix_seconds, 3);
|
assert_eq!(stamp0.secs, 3);
|
||||||
assert_eq!(stamp0.subsecond_millis().unwrap(), 100);
|
assert_eq!(stamp0.subsec_millis(), 100);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -591,4 +746,26 @@ mod tests {
|
||||||
let stamp_error = TimestampError::from(cuc_error);
|
let stamp_error = TimestampError::from(cuc_error);
|
||||||
assert_eq!(stamp_error.to_string(), format!("cuc error: {cuc_error}"));
|
assert_eq!(stamp_error.to_string(), format!("cuc error: {cuc_error}"));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[cfg(feature = "timelib")]
|
||||||
|
fn test_unix_stamp_as_timelib_datetime() {
|
||||||
|
let stamp_epoch = UnixTime::EPOCH;
|
||||||
|
let timelib_dt = stamp_epoch.timelib_date_time().unwrap();
|
||||||
|
assert_eq!(timelib_dt.year(), 1970);
|
||||||
|
assert_eq!(timelib_dt.month(), time::Month::January);
|
||||||
|
assert_eq!(timelib_dt.day(), 1);
|
||||||
|
assert_eq!(timelib_dt.hour(), 0);
|
||||||
|
assert_eq!(timelib_dt.minute(), 0);
|
||||||
|
assert_eq!(timelib_dt.second(), 0);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
#[cfg(feature = "timelib")]
|
||||||
|
fn test_unix_stamp_from_timelib_datetime() {
|
||||||
|
let timelib_dt = time::OffsetDateTime::UNIX_EPOCH;
|
||||||
|
let unix_time = UnixTime::from(timelib_dt);
|
||||||
|
let timelib_converted_back = unix_time.timelib_date_time().unwrap();
|
||||||
|
assert_eq!(timelib_dt, timelib_converted_back);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
76
src/util.rs
76
src/util.rs
|
@ -15,10 +15,12 @@ pub trait ToBeBytes {
|
||||||
impl ToBeBytes for () {
|
impl ToBeBytes for () {
|
||||||
type ByteArray = [u8; 0];
|
type ByteArray = [u8; 0];
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
0
|
0
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
[]
|
[]
|
||||||
}
|
}
|
||||||
|
@ -27,9 +29,12 @@ impl ToBeBytes for () {
|
||||||
impl ToBeBytes for u8 {
|
impl ToBeBytes for u8 {
|
||||||
type ByteArray = [u8; 1];
|
type ByteArray = [u8; 1];
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
1
|
1
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
u8::to_be_bytes(*self)
|
u8::to_be_bytes(*self)
|
||||||
}
|
}
|
||||||
|
@ -38,9 +43,12 @@ impl ToBeBytes for u8 {
|
||||||
impl ToBeBytes for u16 {
|
impl ToBeBytes for u16 {
|
||||||
type ByteArray = [u8; 2];
|
type ByteArray = [u8; 2];
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
2
|
2
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
u16::to_be_bytes(*self)
|
u16::to_be_bytes(*self)
|
||||||
}
|
}
|
||||||
|
@ -49,9 +57,12 @@ impl ToBeBytes for u16 {
|
||||||
impl ToBeBytes for u32 {
|
impl ToBeBytes for u32 {
|
||||||
type ByteArray = [u8; 4];
|
type ByteArray = [u8; 4];
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
4
|
4
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
u32::to_be_bytes(*self)
|
u32::to_be_bytes(*self)
|
||||||
}
|
}
|
||||||
|
@ -60,9 +71,12 @@ impl ToBeBytes for u32 {
|
||||||
impl ToBeBytes for u64 {
|
impl ToBeBytes for u64 {
|
||||||
type ByteArray = [u8; 8];
|
type ByteArray = [u8; 8];
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn written_len(&self) -> usize {
|
fn written_len(&self) -> usize {
|
||||||
8
|
8
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn to_be_bytes(&self) -> Self::ByteArray {
|
fn to_be_bytes(&self) -> Self::ByteArray {
|
||||||
u64::to_be_bytes(*self)
|
u64::to_be_bytes(*self)
|
||||||
}
|
}
|
||||||
|
@ -73,6 +87,15 @@ pub trait UnsignedEnum {
|
||||||
fn size(&self) -> usize;
|
fn size(&self) -> usize;
|
||||||
/// Write the unsigned enumeration to a raw buffer. Returns the written size on success.
|
/// Write the unsigned enumeration to a raw buffer. Returns the written size on success.
|
||||||
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError>;
|
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError>;
|
||||||
|
|
||||||
|
fn value(&self) -> u64;
|
||||||
|
|
||||||
|
#[cfg(feature = "alloc")]
|
||||||
|
fn to_vec(&self) -> alloc::vec::Vec<u8> {
|
||||||
|
let mut buf = alloc::vec![0; self.size()];
|
||||||
|
self.write_to_be_bytes(&mut buf).unwrap();
|
||||||
|
buf
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub trait UnsignedEnumExt: UnsignedEnum + Debug + Copy + Clone + PartialEq + Eq {}
|
pub trait UnsignedEnumExt: UnsignedEnum + Debug + Copy + Clone + PartialEq + Eq {}
|
||||||
|
@ -95,6 +118,7 @@ pub enum UnsignedByteFieldError {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<ByteConversionError> for UnsignedByteFieldError {
|
impl From<ByteConversionError> for UnsignedByteFieldError {
|
||||||
|
#[inline]
|
||||||
fn from(value: ByteConversionError) -> Self {
|
fn from(value: ByteConversionError) -> Self {
|
||||||
Self::ByteConversionError(value)
|
Self::ByteConversionError(value)
|
||||||
}
|
}
|
||||||
|
@ -122,20 +146,24 @@ impl Error for UnsignedByteFieldError {}
|
||||||
/// Type erased variant.
|
/// Type erased variant.
|
||||||
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
pub struct UnsignedByteField {
|
pub struct UnsignedByteField {
|
||||||
width: usize,
|
width: usize,
|
||||||
value: u64,
|
value: u64,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl UnsignedByteField {
|
impl UnsignedByteField {
|
||||||
|
#[inline]
|
||||||
pub const fn new(width: usize, value: u64) -> Self {
|
pub const fn new(width: usize, value: u64) -> Self {
|
||||||
Self { width, value }
|
Self { width, value }
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn value(&self) -> u64 {
|
#[inline]
|
||||||
|
pub const fn value_const(&self) -> u64 {
|
||||||
self.value
|
self.value
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
pub fn new_from_be_bytes(width: usize, buf: &[u8]) -> Result<Self, UnsignedByteFieldError> {
|
pub fn new_from_be_bytes(width: usize, buf: &[u8]) -> Result<Self, UnsignedByteFieldError> {
|
||||||
if width > buf.len() {
|
if width > buf.len() {
|
||||||
return Err(ByteConversionError::FromSliceTooSmall {
|
return Err(ByteConversionError::FromSliceTooSmall {
|
||||||
|
@ -168,10 +196,16 @@ impl UnsignedByteField {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl UnsignedEnum for UnsignedByteField {
|
impl UnsignedEnum for UnsignedByteField {
|
||||||
|
#[inline]
|
||||||
fn size(&self) -> usize {
|
fn size(&self) -> usize {
|
||||||
self.width
|
self.width
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn value(&self) -> u64 {
|
||||||
|
self.value_const()
|
||||||
|
}
|
||||||
|
|
||||||
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
|
fn write_to_be_bytes(&self, buf: &mut [u8]) -> Result<usize, ByteConversionError> {
|
||||||
if buf.len() < self.size() {
|
if buf.len() < self.size() {
|
||||||
return Err(ByteConversionError::ToSliceTooSmall {
|
return Err(ByteConversionError::ToSliceTooSmall {
|
||||||
|
@ -207,21 +241,23 @@ impl UnsignedEnum for UnsignedByteField {
|
||||||
|
|
||||||
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
|
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
|
||||||
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
|
||||||
pub struct GenericUnsignedByteField<TYPE: Copy> {
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
||||||
|
pub struct GenericUnsignedByteField<TYPE: Copy + Into<u64>> {
|
||||||
value: TYPE,
|
value: TYPE,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<TYPE: Copy> GenericUnsignedByteField<TYPE> {
|
impl<TYPE: Copy + Into<u64>> GenericUnsignedByteField<TYPE> {
|
||||||
pub const fn new(val: TYPE) -> Self {
|
pub const fn new(val: TYPE) -> Self {
|
||||||
Self { value: val }
|
Self { value: val }
|
||||||
}
|
}
|
||||||
|
|
||||||
pub const fn value(&self) -> TYPE {
|
pub const fn value_typed(&self) -> TYPE {
|
||||||
self.value
|
self.value
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<TYPE: Copy + ToBeBytes> UnsignedEnum for GenericUnsignedByteField<TYPE> {
|
impl<TYPE: Copy + ToBeBytes + Into<u64>> UnsignedEnum for GenericUnsignedByteField<TYPE> {
|
||||||
|
#[inline]
|
||||||
fn size(&self) -> usize {
|
fn size(&self) -> usize {
|
||||||
self.value.written_len()
|
self.value.written_len()
|
||||||
}
|
}
|
||||||
|
@ -233,9 +269,14 @@ impl<TYPE: Copy + ToBeBytes> UnsignedEnum for GenericUnsignedByteField<TYPE> {
|
||||||
expected: self.size(),
|
expected: self.size(),
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
buf[0..self.size()].copy_from_slice(self.value.to_be_bytes().as_ref());
|
buf[..self.size()].copy_from_slice(self.value.to_be_bytes().as_ref());
|
||||||
Ok(self.value.written_len())
|
Ok(self.value.written_len())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[inline]
|
||||||
|
fn value(&self) -> u64 {
|
||||||
|
self.value_typed().into()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub type UnsignedByteFieldEmpty = GenericUnsignedByteField<()>;
|
pub type UnsignedByteFieldEmpty = GenericUnsignedByteField<()>;
|
||||||
|
@ -258,6 +299,7 @@ impl From<UnsignedByteFieldU8> for UnsignedByteField {
|
||||||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU8 {
|
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU8 {
|
||||||
type Error = UnsignedByteFieldError;
|
type Error = UnsignedByteFieldError;
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||||
if value.width != 1 {
|
if value.width != 1 {
|
||||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||||
|
@ -270,6 +312,7 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU8 {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<UnsignedByteFieldU16> for UnsignedByteField {
|
impl From<UnsignedByteFieldU16> for UnsignedByteField {
|
||||||
|
#[inline]
|
||||||
fn from(value: UnsignedByteFieldU16) -> Self {
|
fn from(value: UnsignedByteFieldU16) -> Self {
|
||||||
Self::new(2, value.value as u64)
|
Self::new(2, value.value as u64)
|
||||||
}
|
}
|
||||||
|
@ -278,6 +321,7 @@ impl From<UnsignedByteFieldU16> for UnsignedByteField {
|
||||||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU16 {
|
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU16 {
|
||||||
type Error = UnsignedByteFieldError;
|
type Error = UnsignedByteFieldError;
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||||
if value.width != 2 {
|
if value.width != 2 {
|
||||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||||
|
@ -290,6 +334,7 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU16 {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<UnsignedByteFieldU32> for UnsignedByteField {
|
impl From<UnsignedByteFieldU32> for UnsignedByteField {
|
||||||
|
#[inline]
|
||||||
fn from(value: UnsignedByteFieldU32) -> Self {
|
fn from(value: UnsignedByteFieldU32) -> Self {
|
||||||
Self::new(4, value.value as u64)
|
Self::new(4, value.value as u64)
|
||||||
}
|
}
|
||||||
|
@ -298,6 +343,7 @@ impl From<UnsignedByteFieldU32> for UnsignedByteField {
|
||||||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU32 {
|
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU32 {
|
||||||
type Error = UnsignedByteFieldError;
|
type Error = UnsignedByteFieldError;
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||||
if value.width != 4 {
|
if value.width != 4 {
|
||||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||||
|
@ -310,6 +356,7 @@ impl TryFrom<UnsignedByteField> for UnsignedByteFieldU32 {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<UnsignedByteFieldU64> for UnsignedByteField {
|
impl From<UnsignedByteFieldU64> for UnsignedByteField {
|
||||||
|
#[inline]
|
||||||
fn from(value: UnsignedByteFieldU64) -> Self {
|
fn from(value: UnsignedByteFieldU64) -> Self {
|
||||||
Self::new(8, value.value)
|
Self::new(8, value.value)
|
||||||
}
|
}
|
||||||
|
@ -318,6 +365,7 @@ impl From<UnsignedByteFieldU64> for UnsignedByteField {
|
||||||
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU64 {
|
impl TryFrom<UnsignedByteField> for UnsignedByteFieldU64 {
|
||||||
type Error = UnsignedByteFieldError;
|
type Error = UnsignedByteFieldError;
|
||||||
|
|
||||||
|
#[inline]
|
||||||
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
fn try_from(value: UnsignedByteField) -> Result<Self, Self::Error> {
|
||||||
if value.width != 8 {
|
if value.width != 8 {
|
||||||
return Err(UnsignedByteFieldError::InvalidWidth {
|
return Err(UnsignedByteFieldError::InvalidWidth {
|
||||||
|
@ -351,6 +399,8 @@ pub mod tests {
|
||||||
for val in buf.iter().skip(1) {
|
for val in buf.iter().skip(1) {
|
||||||
assert_eq!(*val, 0);
|
assert_eq!(*val, 0);
|
||||||
}
|
}
|
||||||
|
assert_eq!(u8.value_typed(), 5);
|
||||||
|
assert_eq!(u8.value(), 5);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -367,6 +417,8 @@ pub mod tests {
|
||||||
for val in buf.iter().skip(2) {
|
for val in buf.iter().skip(2) {
|
||||||
assert_eq!(*val, 0);
|
assert_eq!(*val, 0);
|
||||||
}
|
}
|
||||||
|
assert_eq!(u16.value_typed(), 3823);
|
||||||
|
assert_eq!(u16.value(), 3823);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -383,6 +435,8 @@ pub mod tests {
|
||||||
(4..8).for_each(|i| {
|
(4..8).for_each(|i| {
|
||||||
assert_eq!(buf[i], 0);
|
assert_eq!(buf[i], 0);
|
||||||
});
|
});
|
||||||
|
assert_eq!(u32.value_typed(), 80932);
|
||||||
|
assert_eq!(u32.value(), 80932);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -396,6 +450,8 @@ pub mod tests {
|
||||||
assert_eq!(len, 8);
|
assert_eq!(len, 8);
|
||||||
let raw_val = u64::from_be_bytes(buf[0..8].try_into().unwrap());
|
let raw_val = u64::from_be_bytes(buf[0..8].try_into().unwrap());
|
||||||
assert_eq!(raw_val, 5999999);
|
assert_eq!(raw_val, 5999999);
|
||||||
|
assert_eq!(u64.value_typed(), 5999999);
|
||||||
|
assert_eq!(u64.value(), 5999999);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -534,9 +590,9 @@ pub mod tests {
|
||||||
u8.write_to_be_bytes(&mut buf)
|
u8.write_to_be_bytes(&mut buf)
|
||||||
.expect("writing to raw buffer failed");
|
.expect("writing to raw buffer failed");
|
||||||
assert_eq!(buf[0], 5);
|
assert_eq!(buf[0], 5);
|
||||||
for i in 1..8 {
|
(1..8).for_each(|i| {
|
||||||
assert_eq!(buf[i], 0);
|
assert_eq!(buf[i], 0);
|
||||||
}
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
@ -562,9 +618,9 @@ pub mod tests {
|
||||||
.expect("writing to raw buffer failed");
|
.expect("writing to raw buffer failed");
|
||||||
let raw_val = u32::from_be_bytes(buf[0..4].try_into().unwrap());
|
let raw_val = u32::from_be_bytes(buf[0..4].try_into().unwrap());
|
||||||
assert_eq!(raw_val, 80932);
|
assert_eq!(raw_val, 80932);
|
||||||
for i in 4..8 {
|
(4..8).for_each(|i| {
|
||||||
assert_eq!(buf[i], 0);
|
assert_eq!(buf[i], 0);
|
||||||
}
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
|
|
Loading…
Reference in New Issue
Block a user