Karolin Varner
b40b7f4f2f
chore: cargo update
...
- Had to remove the test checking for manpages to be generated for
the keygen command since clap-mangen disabled creating manpages
for hidden commands.
d96cc71626
- Had to pin home to the previous version because it now requires a
new rust version without major version update
- Changed util/src/fd tests due to false positives in CI
> note: panic did not contain expected string
> panic message: `"fd != -1"`,
> expected substring: `"fd != u32::MAX as RawFd"`
2025-02-22 17:45:34 +01:00
Philipp Dresselmann
ec6706ffeb
chore(docs): Add a docstring example for uds_send_fd
2024-12-19 11:42:46 +01:00
Philipp Dresselmann
f87e2cb31b
chore(doc): Fix module descriptions for length_prefix_encoding
...
There's a more complete module description for the encoder and decoder now. Both versions get appended by rustdoc, which looks wrong and shouldn't be necessary.
2024-12-18 16:24:50 +01:00
Philipp Dresselmann
58e1c8fbff
chore(coverage): Add unit tests for the LengthPrefixEncoder
...
There's some redundancy here with the docstring examples/tests, but that's entirely on purpose:
Unfortunately, it seems that the coverage tool has trouble recognizing calls from within the docstring examples. It's an unstable feature - maybe that's why?
Even with these tests, the tool still doesn't properly detect everything. Regardless, function coverage is 100% when running the coverage tool locally.
2024-12-18 16:24:50 +01:00
Philipp Dresselmann
c89c7d7acf
chore(doc): Add docstring examples for the LengthPrefixEncoder
2024-12-18 16:24:50 +01:00
Philipp Dresselmann
a5b876f119
chore(doc): Add a module summary for LengthPrefixEncoder
2024-12-18 16:23:13 +01:00
Philipp Dresselmann
c2f50f47b3
chore(doc): Update docstrings for LengthPrefixEncoder
...
This is more consistent with the LengthPrefixDecoder documentation.
2024-12-18 16:23:13 +01:00
Paul Spooren
d807a1bca7
Add examples and docstring improvements for mio/uds_recv_fd ( #551 )
2024-12-18 12:29:20 +01:00
Amin Faez
2e0e2cfa0c
docs(util): add docs and examples for the remaining util crate
2024-12-17 11:55:23 +01:00
Philipp Dresselmann
a537eb3e1b
chore(docs): Adjust docstrings for the mio module
2024-12-16 22:29:01 +01:00
Philipp Dresselmann
ea233bf137
chore(docs): Add an example for the UnixListenerExt trait
2024-12-16 22:28:53 +01:00
Philipp Dresselmann
db8796ab40
chore(docs): Add an example for the uds_recv_fd module
2024-12-16 20:54:08 +01:00
Philipp Dresselmann
51d4dede15
chore(doc): Add a link to the MIO utils module summary
2024-12-16 17:02:43 +01:00
Paul Spooren
a996f194c7
docs(util): add docs and examples to the zerocopy module ( #532 )
2024-12-16 11:25:24 +01:00
Amin Faez
ef4f550abc
docs(util): fix doc reference in the zerocopy module
2024-12-15 13:05:55 +01:00
Amin Faez
4737cd2b2a
docs(util): fix doc reference in decoder.rs
...
docs(util): add more tests and example to complete coverage
2024-12-15 12:48:47 +01:00
Amin Faez
9336794e4d
docs(util): add docs and examples to the zerocopy module
2024-12-14 03:00:27 +01:00
Amin Faez
5251721bcf
Add docs and tests for the decoder module in length_prefix_encoding
2024-12-10 16:13:16 +01:00
Karolin Varner
b483612cb7
feat(protocol): Hash-based retransmission mechanism
...
See the updated whitepaper for details.
Fixes : #331
2024-12-07 12:36:40 +01:00
Karolin Varner
1275b992a0
Merge branch 'main' into rustix
2024-11-28 21:01:07 +01:00
Martin Kröning
19b31bcdf0
refactor(mio): close FDs via std instead of rustix
...
Signed-off-by: Martin Kröning <martin.kroening@eonerc.rwth-aachen.de >
2024-11-11 11:14:33 +01:00
Martin Kröning
939d216027
refactor: import FD traits from std instead of rustix
...
Signed-off-by: Martin Kröning <martin.kroening@eonerc.rwth-aachen.de >
2024-11-11 11:14:33 +01:00
Paul Spooren
1d1c0e9da7
chore(examples): add examples to docs
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
e19b724673
docs(typenum): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
f879ad5020
docs(result): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
29e7087cb5
docs(mem): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
637a08d222
docs(io): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
6416c247f4
docs(fd): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
4b3b7e41e4
docs(util): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
325fb915f0
docs(result): add docstring and examples
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
43cb0c09c5
docs(length_prefix_encoding): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
0836a2eb28
docs(zerocopy): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
ca7df013d5
docs(option): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
1209d68718
docs(zeroize): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Paul Spooren
8806494899
docs(mio): fix docstring warnings
...
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-11-08 11:17:43 +01:00
Karolin Varner
6aea3c0c1f
chore: Documentation and unit tests for rosenpass_util::io
2024-10-24 14:01:20 +02:00
Karolin Varner
e4fdfcae08
chore: Documentation and unit tests for rosenpass_util::functional
2024-10-24 14:01:20 +02:00
Karolin Varner
48e629fff7
feat: sideffect/mutating should take FnMut over Fn
2024-10-24 14:01:20 +02:00
Karolin Varner
6321bb36fc
chore: Formatting
2024-10-24 14:01:20 +02:00
Karolin Varner
2f9ff487ba
chore: Unused import
2024-10-24 14:01:20 +02:00
Karolin Varner
c0c06cd1dc
chore: Wrong formatting for module doc
2024-10-24 14:01:20 +02:00
Karolin Varner
e9772effa6
chore: Documentation and unit tests for rosenpass_util::file
2024-10-24 14:01:20 +02:00
Karolin Varner
cf68f15674
chore: Documentation and unit tests for rosenpass_util::fd
2024-10-24 14:01:20 +02:00
Karolin Varner
dd5d45cdc9
chore: Documentation and unit tests for rosenpass_util::controlflow
2024-10-24 14:01:20 +02:00
Karolin Varner
3ae52b9824
chore: Documentation and unit tests for crate rosenpass-util::build
2024-10-13 19:22:14 +02:00
Karolin Varner
cbf361206b
chore: Documentation and unit tests for crate rosenpass-util::b64
2024-10-13 17:21:30 +02:00
Paul Spooren
d913e19883
test: add tests for controlflow
...
While at it, fix the label handling and fix a typo in continue_if, where
a `break` falsely replaced a `continue`
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-08-19 17:24:38 +02:00
Paul Spooren
1555d0897b
feat(ord): drop obsolete RTX_BUFFER_SIZE and usize_max
...
The RTX_BUFFER_SIZE function is nowhere used in the code and when
dropping it, usize_max (const version of max()) becomes obsolete, too.
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-08-19 17:24:37 +02:00
Paul Spooren
abdbf8f3da
feat(util/time): cleanup, document and add tests
...
Drop the unused `dur` function, it's nowhere found in the code.
Document both Timebase and Timebase::now()
Add tests
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-08-19 17:24:16 +02:00
Paul Spooren
9f78531979
tests: cleanup fd.rs tests
...
Trigger the internal assert of owned.rs instead of writing our own. To
correctly test it use `should_panic` macro.
Signed-off-by: Paul Spooren <mail@aparcar.org >
2024-08-19 17:24:16 +02:00