diff options
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; |