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

113 lines
3.8 KiB
Rust

// 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.
#![doc = include_str!("../README.md")]
#![warn(missing_debug_implementations, missing_docs)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
pub use async_trait::async_trait;
pub use bytes;
pub use matrix_sdk_base::{
deserialized_responses, DisplayName, Room as BaseRoom, RoomInfo, RoomMember as BaseRoomMember,
RoomState, Session, StateChanges, StoreError,
};
pub use matrix_sdk_common::*;
pub use reqwest;
#[doc(no_inline)]
pub use ruma;
mod account;
pub mod attachment;
mod client;
pub mod config;
mod error;
pub mod event_handler;
mod http_client;
pub mod media;
pub mod room;
pub mod sync;
#[cfg(feature = "experimental-sliding-sync")]
pub mod sliding_sync;
#[cfg(feature = "e2e-encryption")]
pub mod encryption;
#[cfg(feature = "experimental-timeline")]
mod events;
pub use account::Account;
#[cfg(feature = "sso-login")]
pub use client::SsoLoginBuilder;
pub use client::{Client, ClientBuildError, ClientBuilder, LoginBuilder, LoopCtrl, UnknownToken};
#[cfg(feature = "image-proc")]
pub use error::ImageError;
pub use error::{Error, HttpError, HttpResult, RefreshTokenError, Result, RumaApiError};
pub use http_client::HttpSend;
pub use media::Media;
pub use ruma::{IdParseError, OwnedServerName, ServerName};
#[cfg(feature = "experimental-sliding-sync")]
pub use sliding_sync::{
RoomListEntry, SlidingSync, SlidingSyncBuilder, SlidingSyncList, SlidingSyncListBuilder,
SlidingSyncMode, SlidingSyncRoom, SlidingSyncState, UpdateSummary,
};
#[cfg(any(test, feature = "testing"))]
pub mod test_utils;
#[cfg(all(test, not(target_arch = "wasm32")))]
#[ctor::ctor]
fn init_logging() {
use tracing_subscriber::{layer::SubscriberExt, util::SubscriberInitExt};
tracing_subscriber::registry()
.with(tracing_subscriber::EnvFilter::from_default_env())
.with(tracing_subscriber::fmt::layer().with_test_writer())
.init();
}
/// Creates a server name from a user supplied string. The string is first
/// sanitized by removing whitespace, the http(s) scheme and any trailing
/// slashes before being parsed.
pub fn sanitize_server_name(s: &str) -> Result<OwnedServerName, IdParseError> {
ServerName::parse(
s.trim().trim_start_matches("http://").trim_start_matches("https://").trim_end_matches('/'),
)
}
#[cfg(test)]
mod tests {
use assert_matches::assert_matches;
use crate::sanitize_server_name;
#[test]
fn test_sanitize_server_name() {
assert_eq!(sanitize_server_name("matrix.org").unwrap().as_str(), "matrix.org");
assert_eq!(sanitize_server_name("https://matrix.org").unwrap().as_str(), "matrix.org");
assert_eq!(sanitize_server_name("http://matrix.org").unwrap().as_str(), "matrix.org");
assert_eq!(
sanitize_server_name("https://matrix.server.org").unwrap().as_str(),
"matrix.server.org"
);
assert_eq!(
sanitize_server_name("https://matrix.server.org/").unwrap().as_str(),
"matrix.server.org"
);
assert_eq!(
sanitize_server_name(" https://matrix.server.org// ").unwrap().as_str(),
"matrix.server.org"
);
assert_matches!(sanitize_server_name("https://matrix.server.org/something"), Err(_))
}
}