Skip to content

Commit 13beea5

Browse files
authored
kem: add serialization docs (#2355)
1 parent ea57736 commit 13beea5

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

kem/src/lib.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,17 @@
4949
//! # }
5050
//! ```
5151
//!
52+
//! ## Serialization
53+
//!
54+
//! The [`KeyInit`] and [`KeyExport`] traits can be used to load and store encoded decapsulation
55+
//! and encapsulation keys from their byte serialization.
56+
//!
57+
//! Decapsulation keys are often initialized from a compact representation known as a [`Seed`].
58+
//! The [`FromSeed`] trait provides an extension to the [`Kem`] trait for initializing keypairs
59+
//! from a seed value. We recommend the [`KeyInit`] and [`KeyExport`] trait impls on
60+
//! decapsulation keys operate on seed values when there is a choice of multiple key formats
61+
//! (e.g. expanded decapsulation keys).
62+
//!
5263
//! [RFC 9180]: https://www.rfc-editor.org/info/rfc9180
5364
5465
pub use common::{

0 commit comments

Comments
 (0)