actix/actix-net
1
0
Fork 0
mirror of https://github.com/fafhrd91/actix-net synced 2024-11-27 15:42:57 +01:00
Code Issues Releases Wiki Activity

doc: fix doc references

Browse Source
This commit is contained in:
Rob Ede 2023-10-29 18:45:12 +00:00
parent 17fd135349
commit 09548c96b0
No known key found for this signature in database
GPG Key ID: 97C636207D3EF933
2 changed files with 19 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
actix-rt/src/system.rs
View File

@ -203,16 +203,20 @@ impl SystemRunner {
.map_err(|err| io::Error::new(io::ErrorKind::Other, err)) .map_err(|err| io::Error::new(io::ErrorKind::Other, err))
} }
/// Retrieves a reference to the underlying Actix runtime associated with this SystemRunner instance. /// Retrieves a reference to the underlying [Actix runtime](crate::Runtime) associated with this
/// `SystemRunner` instance.
/// ///
/// The Actix runtime is responsible for managing the event loop for an Actix system and executing asynchronous tasks. /// The Actix runtime is responsible for managing the event loop for an Actix system and
/// This method provides access to the runtime, allowing direct interaction with its features. /// executing asynchronous tasks. This method provides access to the runtime, allowing direct
/// interaction with its features.
/// ///
/// In a typical use case, you might need to share the same runtime between different /// In a typical use case, you might need to share the same runtime between different
/// parts of your project. For example, some components might require a [`actix_rt::Runtime`] to spawn tasks on /// parts of your project. For example, some components might require a [`Runtime`] to spawn
/// the same runtime. /// tasks on the same runtime.
/// ///
/// # Example /// Read more in the documentation for [`Runtime`].
///
/// # Examples
/// ///
/// ``` /// ```
/// let system_runner = actix_rt::System::new(); /// let system_runner = actix_rt::System::new();
@ -221,19 +225,14 @@ impl SystemRunner {
/// // Use the runtime to spawn an async task or perform other operations /// // Use the runtime to spawn an async task or perform other operations
/// ``` /// ```
/// ///
/// Read more in the documentation for [`actix_rt::Runtime`]
///
/// # Returns
///
/// An immutable reference to the [`actix_rt::Runtime`] instance associated with this
/// [`actix_rt::SystemRunner`] instance.
///
/// # Note /// # Note
/// ///
/// While this method provides an immutable reference to the Actix runtime, which is safe to share across threads, /// While this method provides an immutable reference to the Actix runtime, which is safe to
/// be aware that spawning blocking tasks on the Actix runtime could potentially impact system performance. /// share across threads, be aware that spawning blocking tasks on the Actix runtime could
/// This is because the Actix runtime is responsible for driving the system, /// potentially impact system performance. This is because the Actix runtime is responsible for
/// and blocking tasks could delay other tasks in the run loop. /// driving the system, and blocking tasks could delay other tasks in the run loop.
///
/// [`Runtime`]: crate::Runtime
pub fn runtime(&self) -> &crate::runtime::Runtime { pub fn runtime(&self) -> &crate::runtime::Runtime {
&self.rt &self.rt
} }

4
actix-server/src/builder.rs
View File

@ -13,7 +13,9 @@ use crate::{
/// Multipath TCP (MPTCP) preference. /// Multipath TCP (MPTCP) preference.
/// ///
/// Also see [`ServerBuilder::mptcp()`]. /// Currently only useful on Linux.
///
#[cfg_attr(target_os = "linux", doc = "Also see [`ServerBuilder::mptcp()`].")]
#[derive(Debug, Clone)] #[derive(Debug, Clone)]
pub enum MpTcp { pub enum MpTcp {
/// MPTCP will not be used when binding sockets. /// MPTCP will not be used when binding sockets.