search

rozbb / rust-hpke

An implementation of the HPKE hybrid encryption standard (RFC 9180)
Other
62 stars 31 forks source link

Improved error condition docs for labeled_expand() and export() #32

Closed rozbb closed 2 years ago

rozbb commented 2 years ago

@tbrezot I've written the docs we talked about in #28 . Does this look okay?

codecov-commenter commented 2 years ago

Codecov Report

Base: 71.54% // Head: 72.51% // Increases project coverage by +0.96% :tada:

Coverage data is based on head (625d91c) compared to base (a959920). Patch coverage: 50.00% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #32 +/- ## ========================================== + Coverage 71.54% 72.51% +0.96% ========================================== Files 15 15 Lines 1065 1077 +12 ========================================== + Hits 762 781 +19 + Misses 303 296 -7 ``` | [Impacted Files](https://codecov.io/gh/rozbb/rust-hpke/pull/32?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Michael+Rosenberg) | Coverage Δ | | |---|---|---| | [src/aead.rs](https://codecov.io/gh/rozbb/rust-hpke/pull/32/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Michael+Rosenberg#diff-c3JjL2FlYWQucnM=) | `87.95% <ø> (-1.62%)` | :arrow_down: | | [src/kdf.rs](https://codecov.io/gh/rozbb/rust-hpke/pull/32/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Michael+Rosenberg#diff-c3JjL2tkZi5ycw==) | `94.11% <50.00%> (-5.89%)` | :arrow_down: | | [src/aead/export\_only.rs](https://codecov.io/gh/rozbb/rust-hpke/pull/32/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Michael+Rosenberg#diff-c3JjL2FlYWQvZXhwb3J0X29ubHkucnM=) | `83.33% <0.00%> (ø)` | | | [src/lib.rs](https://codecov.io/gh/rozbb/rust-hpke/pull/32/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Michael+Rosenberg#diff-c3JjL2xpYi5ycw==) | `26.60% <0.00%> (+5.05%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Michael+Rosenberg). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Michael+Rosenberg)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

tbrezot commented 2 years ago

@tbrezot I've written the docs we talked about in #28 . Does this look okay?

Yes it does !

rozbb commented 2 years ago

Great. And good catch re clippy. It's fixed now. Thanks for the help!