2020-02-21 15:54:05 +00:00
|
|
|
// Copyright 2020 Damir Jelić
|
|
|
|
// Copyright 2020 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.
|
|
|
|
|
2020-02-21 13:29:46 +00:00
|
|
|
//! This crate implements a [Matrix](https://matrix.org/) client library.
|
2020-03-19 12:55:58 +00:00
|
|
|
//!
|
|
|
|
//! ## Crate Feature Flags
|
|
|
|
//!
|
|
|
|
//! The following crate feature flags are available:
|
|
|
|
//!
|
|
|
|
//! * `encryption`: Enables end-to-end encryption support in the library.
|
2020-08-13 09:06:26 +00:00
|
|
|
//! * `sqlite_cryptostore`: Enables a SQLite based store for the encryption
|
2020-03-19 12:55:58 +00:00
|
|
|
//! keys. If this is disabled and `encryption` support is enabled the keys will
|
|
|
|
//! by default be stored only in memory and thus lost after the client is
|
|
|
|
//! destroyed.
|
2020-08-26 13:17:41 +00:00
|
|
|
//! * `socks`: Enables SOCKS support in reqwest, the default HTTP client.
|
2020-05-13 10:47:24 +00:00
|
|
|
|
|
|
|
#![deny(
|
|
|
|
missing_debug_implementations,
|
|
|
|
dead_code,
|
|
|
|
missing_docs,
|
|
|
|
trivial_casts,
|
|
|
|
trivial_numeric_casts,
|
|
|
|
unused_extern_crates,
|
|
|
|
unused_import_braces,
|
|
|
|
unused_qualifications
|
|
|
|
)]
|
2020-08-13 10:18:24 +00:00
|
|
|
#![cfg_attr(feature = "docs", feature(doc_cfg))]
|
2019-10-20 11:56:46 +00:00
|
|
|
|
2020-08-21 16:32:15 +00:00
|
|
|
#[cfg(not(any(feature = "native-tls", feature = "rustls-tls",)))]
|
|
|
|
compile_error!("one of 'native-tls' or 'rustls-tls' features must be enabled");
|
|
|
|
|
|
|
|
#[cfg(all(feature = "native-tls", feature = "rustls-tls",))]
|
|
|
|
compile_error!("only one of 'native-tls' or 'rustls-tls' features can be enabled");
|
|
|
|
|
2020-05-08 14:12:21 +00:00
|
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
|
|
pub use matrix_sdk_base::JsonStore;
|
2020-08-17 13:34:05 +00:00
|
|
|
#[cfg(feature = "encryption")]
|
|
|
|
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
2020-08-19 09:20:08 +00:00
|
|
|
pub use matrix_sdk_base::LocalTrust;
|
2020-07-30 23:22:48 +00:00
|
|
|
pub use matrix_sdk_base::{
|
2020-08-04 21:42:24 +00:00
|
|
|
CustomEvent, Error as BaseError, EventEmitter, Room, RoomState, Session, StateStore, SyncRoom,
|
2020-07-30 23:22:48 +00:00
|
|
|
};
|
2020-08-13 10:18:24 +00:00
|
|
|
|
2020-07-12 01:12:40 +00:00
|
|
|
#[cfg(feature = "messages")]
|
2020-08-13 10:18:24 +00:00
|
|
|
#[cfg_attr(feature = "docs", doc(cfg(messages)))]
|
2020-07-31 13:15:18 +00:00
|
|
|
pub use matrix_sdk_base::{MessageQueue, PossiblyRedactedExt};
|
2020-08-13 10:18:24 +00:00
|
|
|
|
2020-05-07 06:51:59 +00:00
|
|
|
pub use matrix_sdk_common::*;
|
2020-08-26 12:47:43 +00:00
|
|
|
pub use reqwest;
|
2019-10-20 11:56:46 +00:00
|
|
|
|
2020-05-08 09:40:33 +00:00
|
|
|
mod client;
|
2020-05-08 10:39:36 +00:00
|
|
|
mod error;
|
2020-07-29 08:56:18 +00:00
|
|
|
mod http_client;
|
2020-08-04 09:41:20 +00:00
|
|
|
|
2020-08-17 13:34:05 +00:00
|
|
|
#[cfg(feature = "encryption")]
|
|
|
|
mod device;
|
2020-08-04 09:41:20 +00:00
|
|
|
#[cfg(feature = "encryption")]
|
2020-07-29 12:19:47 +00:00
|
|
|
mod sas;
|
|
|
|
|
2020-05-08 12:02:49 +00:00
|
|
|
pub use client::{Client, ClientConfig, SyncSettings};
|
2020-08-17 13:34:05 +00:00
|
|
|
#[cfg(feature = "encryption")]
|
|
|
|
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
|
|
|
pub use device::Device;
|
2020-05-08 10:39:36 +00:00
|
|
|
pub use error::{Error, Result};
|
2020-08-11 15:25:33 +00:00
|
|
|
pub use http_client::HttpSend;
|
2020-07-29 12:19:47 +00:00
|
|
|
#[cfg(feature = "encryption")]
|
2020-08-13 10:18:24 +00:00
|
|
|
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
|
2020-07-29 12:19:47 +00:00
|
|
|
pub use sas::Sas;
|
2019-10-30 18:30:55 +00:00
|
|
|
|
2020-05-13 13:02:28 +00:00
|
|
|
#[cfg(not(target_arch = "wasm32"))]
|
2019-11-26 18:19:22 +00:00
|
|
|
pub(crate) const VERSION: &str = env!("CARGO_PKG_VERSION");
|