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

55 lines
1.8 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.
//! * `sqlite-cryptostore`: Enables a SQLite based store for the encryption
//! 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-02-21 13:29:46 +00:00
#![deny(missing_docs)]
2019-10-20 11:56:46 +00:00
2020-03-18 13:15:56 +00:00
pub use crate::{error::Error, error::Result, session::Session};
pub use matrix_sdk_types::*;
2019-11-10 17:33:06 +00:00
pub use reqwest::header::InvalidHeaderValue;
2019-10-20 11:56:46 +00:00
mod async_client;
mod base_client;
2019-10-20 11:56:46 +00:00
mod error;
mod event_emitter;
mod models;
mod request_builder;
2019-10-20 11:56:46 +00:00
mod session;
mod state;
2019-10-20 11:56:46 +00:00
#[cfg(test)]
pub mod test_builder;
2020-04-06 11:12:02 +00:00
pub use async_client::{AsyncClient, AsyncClientConfig, SyncSettings};
pub use base_client::Client;
pub use event_emitter::EventEmitter;
#[cfg(feature = "encryption")]
pub use matrix_sdk_crypto::{Device, TrustState};
pub use models::Room;
2020-04-14 10:42:42 +00:00
pub use request_builder::{MessagesRequestBuilder, RoomBuilder};
2020-04-15 21:55:27 +00:00
pub use state::{JsonStore, StateStore};
2019-11-26 18:19:22 +00:00
pub(crate) const VERSION: &str = env!("CARGO_PKG_VERSION");