diff options
| author | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-11-14 19:41:11 +0100 |
|---|---|---|
| committer | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-11-14 19:41:11 +0100 |
| commit | 8c5fa422280ba51fca67086dbfdb5dd6a836f98c (patch) | |
| tree | 578b4e98763a732eec7a395815c6f19e2c2516ab /src/blocking.rs | |
| parent | d8f38a82885a42a7af2c0ea9de542251762f7970 (diff) | |
add module level documentation0.1.0
Diffstat (limited to 'src/blocking.rs')
| -rw-r--r-- | src/blocking.rs | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/src/blocking.rs b/src/blocking.rs index 3429153..4c73837 100644 --- a/src/blocking.rs +++ b/src/blocking.rs @@ -1,3 +1,11 @@ +//! Blocking wrappers around the asynchronous API. +//! +//! All functions except for members of the tunnel module internally use their +//! async counterparts inside a temporary tokio runtime. +//! Tunnels are already synchronous. +//! +//! Consult the async modules for documentation. + #[cfg(feature = "tunnel")] pub use crate::tunnel; |