chris/ruwuma
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

common: Improve comments / docs

Browse Source
This commit is contained in:
Jonas Platte 2022-06-23 10:10:31 +02:00 committed by Jonas Platte
parent a4a95e74fa
commit 7c2ea3f33a
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
crates/ruma-common/src/canonical_json.rs
View File

@ -120,7 +120,7 @@ pub fn to_canonical_value<T: Serialize>(
/// ///
/// This is part of the process of signing an event. /// This is part of the process of signing an event.
/// ///
/// Redaction is also suggested when a verifying an event with `verify_event` returns /// Redaction is also suggested when verifying an event with `verify_event` returns
/// `Verified::Signatures`. See the documentation for `Verified` for details. /// `Verified::Signatures`. See the documentation for `Verified` for details.
/// ///
/// Returns a new JSON object with all applicable fields redacted. /// Returns a new JSON object with all applicable fields redacted.
@ -155,8 +155,8 @@ pub fn redact_in_place(
event: &mut CanonicalJsonObject, event: &mut CanonicalJsonObject,
version: &RoomVersionId, version: &RoomVersionId,
) -> Result<(), RedactionError> { ) -> Result<(), RedactionError> {
// Get the content keys here instead of the event type, because we cant teach rust that this is // Get the content keys here even if they're only needed inside the branch below, because we
// a disjoint borrow. // can't teach rust that this is a disjoint borrow with `get_mut("content")`.
let allowed_content_keys: &[&str] = match event.get("type") { let allowed_content_keys: &[&str] = match event.get("type") {
Some(CanonicalJsonValue::String(event_type)) => { Some(CanonicalJsonValue::String(event_type)) => {
allowed_content_keys_for(event_type, version) allowed_content_keys_for(event_type, version)