itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-10-01 12:20:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

runtime: add links in docs for issues and crates (#6473)

Browse Source
This commit is contained in:
Aoi Kurokawa 2024-04-08 17:47:57 +09:00 committed by GitHub
parent 5712aaf995
commit b6d74ac4eb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tokio/src/runtime/builder.rs
View File

@ -838,7 +838,7 @@ impl Builder {
/// ///
/// This option is currently unstable and its implementation is /// This option is currently unstable and its implementation is
/// incomplete. The API may change or be removed in the future. See /// incomplete. The API may change or be removed in the future. See
/// tokio-rs/tokio#4516 for more details. /// issue [tokio-rs/tokio#4516] for more details.
/// ///
/// # Examples /// # Examples
/// ///
@ -870,6 +870,7 @@ impl Builder {
/// ``` /// ```
/// ///
/// [`JoinHandle`]: struct@crate::task::JoinHandle /// [`JoinHandle`]: struct@crate::task::JoinHandle
/// [tokio-rs/tokio#4516]: https://github.com/tokio-rs/tokio/issues/4516
pub fn unhandled_panic(&mut self, behavior: UnhandledPanic) -> &mut Self { pub fn unhandled_panic(&mut self, behavior: UnhandledPanic) -> &mut Self {
if !matches!(self.kind, Kind::CurrentThread) && matches!(behavior, UnhandledPanic::ShutdownRuntime) { if !matches!(self.kind, Kind::CurrentThread) && matches!(behavior, UnhandledPanic::ShutdownRuntime) {
panic!("UnhandledPanic::ShutdownRuntime is only supported in current thread runtime"); panic!("UnhandledPanic::ShutdownRuntime is only supported in current thread runtime");
@ -895,7 +896,7 @@ impl Builder {
/// is stealable. /// is stealable.
/// ///
/// Consider trying this option when the task "scheduled" time is high /// Consider trying this option when the task "scheduled" time is high
/// but the runtime is underutilized. Use tokio-rs/tokio-metrics to /// but the runtime is underutilized. Use [tokio-rs/tokio-metrics] to
/// collect this data. /// collect this data.
/// ///
/// # Unstable /// # Unstable
@ -903,7 +904,7 @@ impl Builder {
/// This configuration option is considered a workaround for the LIFO /// This configuration option is considered a workaround for the LIFO
/// slot not being stealable. When the slot becomes stealable, we will /// slot not being stealable. When the slot becomes stealable, we will
/// revisit whether or not this option is necessary. See /// revisit whether or not this option is necessary. See
/// tokio-rs/tokio#4941. /// issue [tokio-rs/tokio#4941].
/// ///
/// # Examples /// # Examples
/// ///
@ -915,6 +916,9 @@ impl Builder {
/// .build() /// .build()
/// .unwrap(); /// .unwrap();
/// ``` /// ```
///
/// [tokio-rs/tokio-metrics]: https://github.com/tokio-rs/tokio-metrics
/// [tokio-rs/tokio#4941]: https://github.com/tokio-rs/tokio/issues/4941
pub fn disable_lifo_slot(&mut self) -> &mut Self { pub fn disable_lifo_slot(&mut self) -> &mut Self {
self.disable_lifo_slot = true; self.disable_lifo_slot = true;
self self