logo

Function ruma::canonical_json::redact

source · [−]
pub fn redact(
    object: &BTreeMap<String, CanonicalJsonValue, Global>,
    version: &RoomVersionId
) -> Result<BTreeMap<String, CanonicalJsonValue, Global>, RedactionError>
Available on crate feature canonical-json only.
Expand description

Redacts an event using the rules specified in the Matrix client-server specification.

This is part of the process of signing an event.

Redaction is also suggested when verifying an event with verify_event returns Verified::Signatures. See the documentation for Verified for details.

Returns a new JSON object with all applicable fields redacted.

Parameters

  • object: A JSON object to redact.

Errors

Returns an error if:

  • object contains a field called content that is not a JSON object.
  • object contains a field called hashes that is not a JSON object.
  • object contains a field called signatures that is not a JSON object.
  • object is missing the type field or the field is not a JSON string.