Skip to content

Commit 974289f

Browse files
authored
docs(rt): improve rt module overview (#3920)
1 parent 283fd23 commit 974289f

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

src/rt/mod.rs

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,17 @@
11
//! Runtime components
22
//!
3-
//! The traits and types within this module are used to allow plugging in
4-
//! runtime types. These include:
3+
//! This module provides traits and types that allow hyper to be runtime-agnostic.
4+
//! By abstracting over async runtimes, hyper can work with different executors, timers, and IO transports.
55
//!
6-
//! - Executors
7-
//! - Timers
8-
//! - IO transports
6+
//! The main components in this module are:
7+
//!
8+
//! - **Executors**: Traits for spawning and running futures, enabling integration with any async runtime.
9+
//! - **Timers**: Abstractions for sleeping and scheduling tasks, allowing time-based operations to be runtime-independent.
10+
//! - **IO Transports**: Traits for asynchronous reading and writing, so hyper can work with various IO backends.
11+
//!
12+
//! By implementing these traits, you can customize how hyper interacts with your chosen runtime environment.
13+
//!
14+
//! To learn more, [check out the runtime guide](https://hyper.rs/guides/1/init/runtime/).
915
1016
pub mod bounds;
1117
mod io;

0 commit comments

Comments
 (0)