Skip to content

Commit 4948861

Browse files
committed
Doc async runtime support
1 parent 0c293ed commit 4948861

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

Cargo.toml

+3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ tls = ["rustls", "rustls-pemfile", "webpki-roots"]
2020
sasl = ["sasl-gssapi", "sasl-digest-md5"]
2121
sasl-digest-md5 = ["rsasl/unstable_custom_mechanism", "md5", "linkme", "hex"]
2222
sasl-gssapi = ["rsasl/gssapi"]
23+
tokio = ["asyncs/tokio"]
24+
smol = ["asyncs/smol"]
25+
async-global-executor = ["asyncs/async-global-executor"]
2326

2427
[dependencies]
2528
bytes = "1.1.0"

src/lib.rs

+8
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,14 @@
1818
//! * `sasl`: Toggle SASL support.
1919
//! * `sasl-gssapi`: Toggle only GSSAPI SASL support. This relies on binding package `libgssapi-sys`.
2020
//! * `sasl-digest-md5`: Toggle only DIGEST-MD5 SASL support.
21+
//!
22+
//! ## Async runtime support
23+
//! This library uses [asyncs](https://docs.rs/asyncs) and [spawns](https://docs.rs/spawns) to
24+
//! spawn asynchronous tasks. It exposes runtime feature flags for handy. Please refer their docs
25+
//! for references.
26+
//! * `tokio`: Toggle support for [tokio](https://docs.rs/tokio).
27+
//! * `smol`: Toggle support for [smol](https://docs.rs/smol) builtin global executor.
28+
//! * `async-global-executor`: Toggle support for [async-global-executor](https://docs.rs/async-global-executor).
2129
2230
mod acl;
2331
mod chroot;

src/session/request.rs

+1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ pub struct MarshalledRequest(pub Vec<u8>);
1818
#[derive(Clone, Copy, Debug)]
1919
pub enum OpStat<'a> {
2020
None,
21+
#[allow(dead_code)]
2122
Path(&'a str),
2223
Watch { path: &'a str, mode: WatchMode },
2324
}

0 commit comments

Comments
 (0)