Skip to content

Commit

Permalink
docs: Mention that the custom types in the crypto crate implement zer…
Browse files Browse the repository at this point in the history
…oize
  • Loading branch information
poljar committed Aug 8, 2024
1 parent 57963dc commit 4490a34
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions crates/matrix-sdk-crypto/src/types/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@

//! Module containing customized types modeling Matrix keys and events.
//!
//! These types were mostly taken from the Ruma project. The types differ in two
//! important ways to the Ruma types of the same name:
//! These types were mostly taken from the Ruma project. The types differ in a
//! couple of important ways to the Ruma types of the same name:
//!
//! 1. They are using vodozemac types so we directly deserialize into a
//! vodozemac Curve25519 or Ed25519 key.
//! 2. They support lossless serialization cycles in a canonical JSON supported
//! way, meaning the white-space and field order won't be preserved but the
//! data will.
//! 3. Types containing secrets implement the [`Zeroize`] and [`ZeroizeOnDrop`]
//! traits to clear out any memory containing secret key material.
use std::{
borrow::Borrow,
Expand Down

0 comments on commit 4490a34

Please sign in to comment.