@@ -404,9 +404,17 @@ impl Builder {
404
404
/// Specifies the limit for additional threads spawned by the Runtime.
405
405
///
406
406
/// These threads are used for blocking operations like tasks spawned
407
- /// through [`spawn_blocking`]. Unlike the [`worker_threads`], they are not
408
- /// always active and will exit if left idle for too long. You can change
409
- /// this timeout duration with [`thread_keep_alive`].
407
+ /// through [`spawn_blocking`], this includes but is not limited to:
408
+ /// - [`fs`] operations
409
+ /// - dns resolution through [`ToSocketAddrs`]
410
+ /// - writing to [`Stdout`] or [`Stderr`]
411
+ /// - reading from [`Stdin`]
412
+ ///
413
+ /// Unlike the [`worker_threads`], they are not always active and will exit
414
+ /// if left idle for too long. You can change this timeout duration with [`thread_keep_alive`].
415
+ ///
416
+ /// It's recommended to not set this limit too low in order to avoid hanging on operations
417
+ /// requiring [`spawn_blocking`].
410
418
///
411
419
/// The default value is 512.
412
420
///
@@ -420,6 +428,11 @@ impl Builder {
420
428
/// current `max_blocking_threads` does not include async worker threads in the count.
421
429
///
422
430
/// [`spawn_blocking`]: fn@crate::task::spawn_blocking
431
+ /// [`fs`]: mod@crate::fs
432
+ /// [`ToSocketAddrs`]: trait@crate::net::ToSocketAddrs
433
+ /// [`Stdout`]: struct@crate::io::Stdout
434
+ /// [`Stdin`]: struct@crate::io::Stdin
435
+ /// [`Stderr`]: struct@crate::io::Stderr
423
436
/// [`worker_threads`]: Self::worker_threads
424
437
/// [`thread_keep_alive`]: Self::thread_keep_alive
425
438
#[ track_caller]
0 commit comments