matrix-rust-sdk/matrix_sdk/src/lib.rs

87 lines
2.9 KiB
Rust
Raw Normal View History

// 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.
//! * `unstable-synapse-quirks`: Enables support to deal with inconsistencies
//! of Synapse in compliance with the Matrix API specification.
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
)]
#![cfg_attr(feature = "docs", feature(doc_cfg))]
2019-10-20 11:56:46 +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");
#[cfg(feature = "encryption")]
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
pub use matrix_sdk_base::crypto::LocalTrust;
#[cfg(not(target_arch = "wasm32"))]
pub use matrix_sdk_base::JsonStore;
2020-07-30 23:22:48 +00:00
pub use matrix_sdk_base::{
2020-10-07 12:23:37 +00:00
CustomEvent, Error as BaseError, EventEmitter, Room, RoomMember, RoomState, Session,
StateStore, SyncRoom,
2020-07-30 23:22:48 +00:00
};
#[cfg(feature = "messages")]
#[cfg_attr(feature = "docs", doc(cfg(messages)))]
pub use matrix_sdk_base::{MessageQueue, PossiblyRedactedExt};
pub use matrix_sdk_common::*;
2020-08-26 12:47:43 +00:00
pub use reqwest;
2019-10-20 11:56:46 +00:00
mod client;
mod error;
mod http_client;
#[cfg(feature = "encryption")]
mod device;
#[cfg(feature = "encryption")]
2020-07-29 12:19:47 +00:00
mod sas;
pub use client::{Client, ClientConfig, LoopCtrl, SyncSettings};
#[cfg(feature = "encryption")]
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
pub use device::Device;
pub use error::{Error, Result};
pub use http_client::HttpSend;
2020-07-29 12:19:47 +00:00
#[cfg(feature = "encryption")]
#[cfg_attr(feature = "docs", doc(cfg(encryption)))]
2020-07-29 12:19:47 +00:00
pub use sas::Sas;
#[cfg(not(target_arch = "wasm32"))]
2019-11-26 18:19:22 +00:00
pub(crate) const VERSION: &str = env!("CARGO_PKG_VERSION");