mxlink 1.15.0

A library for connecting (linking) to the Matrix Client Server API (for building bots, etc.)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

use std::collections::HashMap;
use std::sync::Arc;

use tokio::sync::Mutex;

use matrix_sdk::Client;
use matrix_sdk::ruma::{OwnedRoomId, OwnedUserId};

use thiserror::Error;

use crate::SyncError;
use crate::persistence::Manager as PersistenceManager;

pub(crate) mod media;
pub(crate) mod messaging;
pub(crate) mod reacting;
pub(crate) mod rooms;
pub(crate) mod syncing;
pub(crate) mod threads;

#[derive(Error, Debug)]
pub enum CallbackError {
    #[error("Error from the matrix SDK: {0}")]
    Sdk(#[from] matrix_sdk::Error),

    #[error("Unknown error: {0}")]
    Unknown(Box<dyn std::error::Error + Send + Sync>),
}

#[derive(Debug)]
struct MatrixLinkInner {
    user_id: OwnedUserId,
    client: Client,
    initial_sync_token: Option<String>,
    persistence_manager: PersistenceManager,

    typing_notices: Mutex<HashMap<OwnedRoomId, Arc<Mutex<u32>>>>,
}

/// MatrixLink represents a connection to a Matrix server.
/// It wraps a matrix_sdk Client and provides some convenience functions for working with it.
///
/// All of the state is held in an `Arc` so the `MatrixLink` can be cloned freely.
#[derive(Debug, Clone)]
pub struct MatrixLink {
    inner: Arc<MatrixLinkInner>,
}

impl MatrixLink {
    pub(super) fn new(
        user_id: OwnedUserId,
        client: Client,
        initial_sync_token: Option<String>,
        persistence_manager: PersistenceManager,
    ) -> Self {
        Self {
            inner: Arc::new(MatrixLinkInner {
                user_id,
                client,
                initial_sync_token,
                persistence_manager,
                typing_notices: Mutex::new(HashMap::new()),
            }),
        }
    }

    pub fn user_id(&self) -> &OwnedUserId {
        &self.inner.user_id
    }

    pub fn client(&self) -> Client {
        self.inner.client.clone()
    }

    pub fn messaging(&self) -> messaging::Messaging {
        messaging::Messaging::new(self.clone())
    }

    pub fn media(&self) -> media::Media {
        media::Media::new()
    }

    pub fn reacting(&self) -> reacting::Reacting {
        reacting::Reacting::new(self.clone())
    }

    pub fn rooms(&self) -> rooms::Rooms {
        rooms::Rooms::new(self.clone())
    }

    pub fn threads(&self) -> threads::Threads {
        threads::Threads::new(self.clone())
    }

    /// Starts the client (listening for events, etc.)
    pub async fn start(&self) -> Result<(), SyncError> {
        syncing::Syncing::new(self.clone()).start().await
    }
}