Skip to content

Commit 708f863

Browse files
Darksonnamab8901
authored andcommitted
tokio: document supported platforms (tokio-rs#5483)
1 parent c05d2bc commit 708f863

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

tokio/src/lib.rs

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,7 +384,33 @@
384384
//! [unstable features]: https://internals.rust-lang.org/t/feature-request-unstable-opt-in-non-transitive-crate-features/16193#why-not-a-crate-feature-2
385385
//! [feature flags]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
386386
//!
387-
//! ## WASM support
387+
//! ## Supported platforms
388+
//!
389+
//! Tokio currently guarantees support for the following platforms:
390+
//!
391+
//! * Linux
392+
//! * Windows
393+
//! * Android (API level 21)
394+
//! * macOS
395+
//! * iOS
396+
//! * FreeBSD
397+
//!
398+
//! Tokio will continue to support these platforms in the future. However,
399+
//! future releases may change requirements such as the minimum required libc
400+
//! version on Linux, the API level on Android, or the supported FreeBSD
401+
//! release.
402+
//!
403+
//! Beyond the above platforms, Tokio is intended to work on all platforms
404+
//! supported by the mio crate. You can find a longer list [in mio's
405+
//! documentation][mio-supported]. However, these additional platforms may
406+
//! become unsupported in the future.
407+
//!
408+
//! Note that Wine is considered to be a different platform from Windows. See
409+
//! mio's documentation for more information on Wine support.
410+
//!
411+
//! [mio-supported]: https://crates.io/crates/mio#platforms
412+
//!
413+
//! ### WASM support
388414
//!
389415
//! Tokio has some limited support for the WASM platform. Without the
390416
//! `tokio_unstable` flag, the following features are supported:

0 commit comments

Comments
 (0)