Function ruma::canonical_json::redact
source · pub fn redact(
object: BTreeMap<String, CanonicalJsonValue>,
version: &RoomVersionId,
redacted_because: Option<RedactedBecause>,
) -> Result<BTreeMap<String, CanonicalJsonValue>, RedactionError>
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.version
: The room version, determines which keys to keep for a few event types.redacted_because
: If this is set, anunsigned
object with aredacted_because
field set to the given value is added to the event after redaction.
§Errors
Returns an error if:
object
contains a field calledcontent
that is not a JSON object.object
contains a field calledhashes
that is not a JSON object.object
contains a field calledsignatures
that is not a JSON object.object
is missing thetype
field or the field is not a JSON string.