char/matrix-rust-sdk
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs(common): Use the readme for the crate level docs

Browse source
This commit is contained in:
Damir Jelić 2021-09-10 12:31:24 +02:00
parent 48b3307934
commit 92b0ba21e4
3 changed files with 15 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
matrix_sdk_common/README.md
View file

@ -1,15 +1,9 @@
[![Build Status](https://img.shields.io/travis/matrix-org/matrix-rust-sdk.svg?style=flat-square)](https://travis-ci.org/matrix-org/matrix-rust-sdk) Common types that are used in the different [matrix-sdk] layers.
[![codecov](https://img.shields.io/codecov/c/github/matrix-org/matrix-rust-sdk/master.svg?style=flat-square)](https://codecov.io/gh/matrix-org/matrix-rust-sdk)
[![License](https://img.shields.io/badge/License-Apache%202.0-yellowgreen.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
[![#matrix-rust-sdk](https://img.shields.io/badge/matrix-%23matrix--rust--sdk-blue?style=flat-square)](https://matrix.to/#/#matrix-rust-sdk:matrix.org)
# matrix-sdk-common **NOTE:** These are common dependencies for the different [matrix-sdk] layers,
**matrix-rust-sdk** is an implementation of a [Matrix][] client-server library in [Rust][].
**NOTE:** These are common dependencies for the different sdk layers,
you're probably interested in the main you're probably interested in the main
[rust-sdk](https://github.com/matrix-org/matrix-rust-sdk/) crate. [matrix-sdk](https://docs.rs/matrix-sdk/) crate.
[matrix-sdk]: https://github.com/matrix-org/matrix-rust-sdk/
[Matrix]: https://matrix.org/ [Matrix]: https://matrix.org/
[Rust]: https://www.rust-lang.org/ [Rust]: https://www.rust-lang.org/

1
matrix_sdk_common/src/deserialized_responses.rs
View file

@ -133,6 +133,7 @@ impl SyncResponse {
} }
} }
#[derive(Clone, Debug)]
pub struct RoomEvent { pub struct RoomEvent {
/// The actual event. /// The actual event.
pub event: Raw<ruma::events::AnyRoomEvent>, pub event: Raw<ruma::events::AnyRoomEvent>,

10
matrix_sdk_common/src/lib.rs
View file

@ -1,3 +1,13 @@
#![doc = include_str!("../README.md")]
#![deny(
missing_debug_implementations,
trivial_casts,
trivial_numeric_casts,
unused_extern_crates,
unused_import_braces,
unused_qualifications
)]
pub use async_trait::async_trait; pub use async_trait::async_trait;
pub use instant; pub use instant;
pub use uuid; pub use uuid;