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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
//! # twilight-http //! //! [![discord badge][]][discord link] [![github badge][]][github link] [![license badge][]][license link] ![rust badge] //! //! HTTP support for the twilight ecosystem. //! //! ## Features //! //! ### Deserialization //! //! `twilight-http` supports [`serde_json`] and [`simd-json`] for deserializing //! responses. //! //! #### `simd-json` //! //! The `simd-json` feature enables [`simd-json`] support to use simd features //! of modern cpus to deserialize responses faster. It is not enabled by //! default. //! //! To use this feature you need to also add these lines to //! `<project root>/.cargo/config`: //! //! ```toml //! [build] //! rustflags = ["-C", "target-cpu=native"] //! ``` //! //! You can also set the environment variable //! `RUSTFLAGS="-C target-cpu=native"`. If you enable both `serde_json` and //! `simd-json` at the same time, then `simd-json` will be used. //! //! To enable `simd-json`, do something like this in your `Cargo.toml`: //! //! ```toml //! [dependencies] //! twilight-http = { default-features = false, features = ["rustls", "simd-json"], version = "0.2" } //! ``` //! //! ### TLS //! //! `twilight-http` has features to enable [`hyper`]'s TLS features. These //! features are mutually exclusive. `rustls` is enabled by default. //! //! #### `native` //! //! The `native` feature enables [`hyper`]'s `default-tls` //! feature, which is mostly equivalent to using [`native-tls`]. //! //! To enable `native`, do something like this in your `Cargo.toml`: //! //! ```toml //! [dependencies] //! twilight-http = { default-features = false, features = ["native"], version = "0.2" } //! ``` //! //! #### `rustls` //! //! The `rustls` feature enables [`hyper`]'s `rustls` feature, which uses //! [`rustls`] as the TLS backend. //! //! This is enabled by default. //! //! [`native-tls`]: https://crates.io/crates/native-tls //! [`hyper`]: https://crates.io/crates/hyper //! [`rustls`]: https://crates.io/crates/rustls //! [`serde_json`]: https://crates.io/crates/serde_json //! [`simd-json`]: https://crates.io/crates/simd-json //! [discord badge]: https://img.shields.io/discord/745809834183753828?color=%237289DA&label=discord%20server&logo=discord&style=for-the-badge //! [discord link]: https://discord.gg/7jj8n7D //! [github badge]: https://img.shields.io/badge/github-twilight-6f42c1.svg?style=for-the-badge&logo=github //! [github link]: https://github.com/twilight-rs/twilight //! [license badge]: https://img.shields.io/badge/license-ISC-blue.svg?style=for-the-badge&logo=pastebin //! [license link]: https://github.com/twilight-rs/twilight/blob/trunk/LICENSE.md //! [rust badge]: https://img.shields.io/badge/rust-1.48+-93450a.svg?style=for-the-badge&logo=rust #![deny( clippy::all, clippy::pedantic, future_incompatible, nonstandard_style, rust_2018_idioms, broken_intra_doc_links, unused, warnings )] #![allow( clippy::module_name_repetitions, clippy::pub_enum_variant_names, clippy::must_use_candidate, clippy::missing_errors_doc, clippy::unnecessary_wraps )] #![cfg_attr(docsrs, feature(doc_cfg))] pub mod api_error; pub mod client; pub mod error; pub mod ratelimiting; pub mod request; pub mod routing; /// Discord API version used by this crate. pub const API_VERSION: u8 = 8; pub use crate::{ client::Client, error::{Error, Result}, }; #[cfg(not(feature = "simd-json"))] use serde_json::Result as JsonResult; #[cfg(feature = "simd-json")] use simd_json::Result as JsonResult; pub(crate) fn json_from_slice<'a, T: serde::de::Deserialize<'a>>(s: &'a mut [u8]) -> JsonResult<T> { #[cfg(not(feature = "simd-json"))] return serde_json::from_slice(s); #[cfg(feature = "simd-json")] return simd_json::from_slice(s); } #[cfg(not(feature = "simd-json"))] pub(crate) use serde_json::to_vec as json_to_vec; #[cfg(feature = "simd-json")] pub(crate) use simd_json::to_vec as json_to_vec; #[cfg(not(any(feature = "native", feature = "rustls")))] compile_error!("Either the `native` or `rustls` feature must be enabled.");