Skip to content

Commit

Permalink
Expand more on choice of serde backend
Browse files Browse the repository at this point in the history
  • Loading branch information
survived committed Mar 18, 2024
1 parent 62d7e7e commit 1543a82
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 6 additions & 3 deletions key-share/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -97,9 +97,12 @@ use serde_with::As;
/// It's unlikely, but at some point, we might introduce a breaking change into the serialization format. In this case,
/// we'll announce it and publish the migration instructions.
///
/// Not every serde backend is supported. We strongly advise using either [`serde_json`](https://docs.rs/serde_json/),
/// if verbose/human-readable format is needed, or [`ciborium`](https://docs.rs/ciborium/latest/ciborium/), if you'd
/// like to opt for binary format. Other serialization backends are not tested and disadvised to use.
/// Not every serde backend supports features that we use to ensure backwards compatibility. We require that field names
/// are being serialized, that helps us adding new fields as the library grows. We strongly advise using either
/// [`serde_json`](https://docs.rs/serde_json/), if verbose/human-readable format is needed, or
/// [`ciborium`](https://docs.rs/ciborium/latest/ciborium/), if you'd like to opt for binary format. Other serialization
/// backends are not tested and may not work or stop working at some point (like [bincode](https://github.com/dfns/cggmp21/issues/89) did)
/// or be not backwards compatible between certain versions.
///
/// If you need the smallest size of serialized key share, we advise implementing serialization manually (all fields of
/// the key share are public!).
Expand Down

0 comments on commit 1543a82

Please sign in to comment.