matrix-sdk 0.19.1

A high level Matrix client-server library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

// Copyright 2026 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use ruma::events::receipt::ReceiptEventContent;
use tokio::sync::broadcast::{Receiver, Sender};

use super::super::{super::RoomEventCacheGenericUpdate, TimelineVectorDiffs};

/// An update related to events happened in a thread.
#[derive(Debug, Clone)]
pub enum ThreadEventCacheUpdate {
    /// The thread has received updates for the timeline as _diffs_.
    UpdateTimelineEvents(TimelineVectorDiffs),

    /// The thread has received a new read receipt event.
    AddReadReceiptEvent {
        /// The event containing the receipts.
        event: ReceiptEventContent,
    },
}

/// A small type to send updates in all channels.
#[derive(Clone)]
pub struct ThreadEventCacheUpdateSender {
    thread_sender: Sender<ThreadEventCacheUpdate>,
    generic_sender: Sender<RoomEventCacheGenericUpdate>,
}

impl ThreadEventCacheUpdateSender {
    /// Create a new [`ThreadEventCacheUpdateSender`].
    pub fn new(generic_sender: Sender<RoomEventCacheGenericUpdate>) -> Self {
        Self { thread_sender: Sender::new(32), generic_sender }
    }

    /// Send a [`TimelineVectorDiffs`].
    pub fn send(
        &self,
        thread_update: ThreadEventCacheUpdate,
        generic_update: Option<RoomEventCacheGenericUpdate>,
    ) {
        let _ = self.thread_sender.send(thread_update);

        if let Some(generic_update) = generic_update {
            let _ = self.generic_sender.send(generic_update);
        }
    }

    /// Create a new [`Receiver`] of [`ThreadEventCacheUpdate`].
    pub(super) fn new_thread_receiver(&self) -> Receiver<ThreadEventCacheUpdate> {
        self.thread_sender.subscribe()
    }
}