matrix_sdk_base/
lib.rs

1// Copyright 2020 Damir Jelić
2// Copyright 2020 The Matrix.org Foundation C.I.C.
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8//     http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15
16#![doc = include_str!("../README.md")]
17#![cfg_attr(docsrs, feature(doc_auto_cfg))]
18#![cfg_attr(target_arch = "wasm32", allow(clippy::arc_with_non_send_sync))]
19#![warn(missing_docs, missing_debug_implementations)]
20
21pub use matrix_sdk_common::*;
22use ruma::{OwnedDeviceId, OwnedUserId};
23use serde::{Deserialize, Serialize};
24
25pub use crate::error::{Error, Result};
26
27mod client;
28pub use client::RequestedRequiredStates;
29pub mod debug;
30pub mod deserialized_responses;
31mod error;
32pub mod event_cache;
33pub mod latest_event;
34pub mod media;
35pub mod notification_settings;
36mod response_processors;
37mod rooms;
38
39pub mod read_receipts;
40pub use read_receipts::PreviousEventsProvider;
41pub mod sliding_sync;
42
43pub mod store;
44pub mod sync;
45#[cfg(any(test, feature = "testing"))]
46mod test_utils;
47mod utils;
48
49#[cfg(feature = "uniffi")]
50uniffi::setup_scaffolding!();
51
52pub use client::BaseClient;
53#[cfg(any(test, feature = "testing"))]
54pub use http;
55#[cfg(feature = "e2e-encryption")]
56pub use matrix_sdk_crypto as crypto;
57pub use once_cell;
58pub use rooms::{
59    apply_redaction, EncryptionState, Room, RoomCreateWithCreatorEventContent, RoomDisplayName,
60    RoomHero, RoomInfo, RoomInfoNotableUpdate, RoomInfoNotableUpdateReasons, RoomMember,
61    RoomMembersUpdate, RoomMemberships, RoomState, RoomStateFilter,
62};
63pub use store::{
64    ComposerDraft, ComposerDraftType, QueueWedgeError, StateChanges, StateStore, StateStoreDataKey,
65    StateStoreDataValue, StoreError,
66};
67pub use utils::{
68    MinimalRoomMemberEvent, MinimalStateEvent, OriginalMinimalStateEvent, RedactedMinimalStateEvent,
69};
70
71#[cfg(test)]
72matrix_sdk_test::init_tracing_for_tests!();
73
74/// The Matrix user session info.
75#[derive(Clone, Debug, Eq, Hash, PartialEq, Serialize, Deserialize)]
76pub struct SessionMeta {
77    /// The ID of the session's user.
78    pub user_id: OwnedUserId,
79    /// The ID of the client device.
80    pub device_id: OwnedDeviceId,
81}
matrix_sdk_base/lib.rs

matrix_sdk_base/
lib.rs
