|
53 | 53 | //! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
|
54 | 54 | //!
|
55 | 55 | //! # Unstable Features
|
| 56 | +//! |
56 | 57 | //! hyper includes a set of unstable optional features that can be enabled through the use of a
|
57 | 58 | //! feature flag and a [configuration flag].
|
58 | 59 | //!
|
|
65 | 66 | //! RUSTFLAGS="--cfg hyper_unstable_tracing" cargo rustc --features client,http1,http2,tracing --crate-type cdylib
|
66 | 67 | //!```
|
67 | 68 | //! [configuration flag]: https://doc.rust-lang.org/reference/conditional-compilation.html
|
| 69 | +//! |
| 70 | +//! # Stability |
| 71 | +//! |
| 72 | +//! It's worth talking a bit about the stability of hyper. hyper's API follows |
| 73 | +//! [SemVer](https://semver.org). Breaking changes will only be introduced in |
| 74 | +//! major versions, if ever. New additions to the API, such as new types, |
| 75 | +//! methods, or traits will only be added in minor versions. |
| 76 | +//! |
| 77 | +//! Some parts of hyper are documented as NOT being part of the stable API. The |
| 78 | +//! following is a brief list, you can read more about each one in the relevant |
| 79 | +//! part of the documentation. |
| 80 | +//! |
| 81 | +//! - Downcasting error types from `Error::source()` is not considered stable. |
| 82 | +//! - Private dependencies use of global variables is not considered stable. |
| 83 | +//! So, if a dependency uses `log` or `tracing`, hyper doesn't promise it |
| 84 | +//! will continue to do so. |
| 85 | +//! - Behavior from default options is not stable. hyper reserves the right to |
| 86 | +//! add new options that are enabled by default which might alter the |
| 87 | +//! behavior, for the purposes of protection. It is also possible to _change_ |
| 88 | +//! what the default options are set to, also in efforts to protect the |
| 89 | +//! most people possible. |
68 | 90 | #[doc(hidden)]
|
69 | 91 | pub use http;
|
70 | 92 |
|
|
0 commit comments