Skip to content

Commit 864fbeb

Browse files
committed
docs(common): Update CHANGELOG.md and doc comments on DecryptedRoomEvent
1 parent 0d711b5 commit 864fbeb

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

crates/matrix-sdk-common/CHANGELOG.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ All notable changes to this project will be documented in this file.
88

99
### Features
1010

11-
- [**breaking**] Use `Raw<AnyTimelineEvent>` in place of `Raw<AnyMessageLikeEvent>` inside `DecryptedRoomEvent` ([#5512](https://github.com/matrix-org/matrix-rust-sdk/pull/5512/files)).
11+
- [**breaking**] Use `Raw<AnyTimelineEvent>` in place of `Raw<AnyMessageLikeEvent>`
12+
inside `DecryptedRoomEvent`.
13+
([#5512](https://github.com/matrix-org/matrix-rust-sdk/pull/5512/files)).
14+
Affects the following functions:
15+
- `OlmMachine::decrypt_room_event` - existing matches on the result's event field
16+
should be updated to `AnyTimelineEvent::MessageLike(AnyMessageLikeEvent::...)`
1217

1318
## [0.13.0] - 2025-07-10
1419

crates/matrix-sdk-common/src/deserialized_responses.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -837,7 +837,8 @@ impl fmt::Debug for TimelineEventKind {
837837
pub struct DecryptedRoomEvent {
838838
/// The decrypted event.
839839
///
840-
/// Note: it's not an error that this contains an `AnyMessageLikeEvent`: an
840+
/// Note: it's not an error that this contains an [`AnyTimelineEvent`]
841+
/// (as opposed to an [`AnySyncTimelineEvent`]): an
841842
/// encrypted payload *always contains* a room id, by the [spec].
842843
///
843844
/// [spec]: https://spec.matrix.org/v1.12/client-server-api/#mmegolmv1aes-sha2

0 commit comments

Comments
 (0)