1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
//! [![license badge][]][license link] [![rust badge]][rust link] //! //! # twilight-model //! //! See the [`twilight`] documentation for more information. //! //! `twilight-model` is a crate of serde models defining the Discord APIs with //! few convenience methods on top of them. //! //! These are in a single crate for ease of use, a single point of definition, //! and a sort of versioning of the Discord API. Similar to how a database //! schema progresses in versions, the definition of the API also progresses in //! versions. //! //! The types in this crate are reproducible: deserializing a payload into a //! type, serializing it, and then deserializing it again will work. //! //! Defined are a number of modules defining types returned by or owned by //! resource categories. For example, `gateway` are types used to interact with //! and returned by the gateway API. `guild` contains types owned by the Guild //! resource category. These types may be directly returned by, built on top of, //! or extended by other crates. //! //! ### Installation //! //! This crate requires Rust 1.31+. //! //! Add the following to your `Cargo.toml`: //! //! ```toml //! twilight-model = "0.1" //! ``` //! //! ## License //! //! [ISC][LICENSE.md] //! //! [LICENSE.md]: https://github.com/twilight-rs/twilight/blob/trunk/LICENSE.md //! [`twilight`]: https://docs.rs/twilight //! [license badge]: https://img.shields.io/badge/license-ISC-blue.svg?style=flat-square //! [license link]: https://opensource.org/licenses/ISC //! [rust badge]: https://img.shields.io/badge/rust-1.31+-93450a.svg?style=flat-square //! [rust link]: https://blog.rust-lang.org/2018/12/06/Rust-1.31-and-rust-2018.html #![deny( clippy::all, clippy::pedantic, future_incompatible, nonstandard_style, rust_2018_idioms, unused, warnings )] #![allow(clippy::module_name_repetitions, clippy::must_use_candidate)] pub mod channel; pub mod gateway; pub mod guild; pub mod id; pub mod invite; pub mod oauth; pub mod user; pub mod voice;