zlink 0.7.0

Async Varlink API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

#![cfg_attr(not(any(feature = "tokio", feature = "smol")), no_std)]
#![doc(
    html_logo_url = "https://raw.githubusercontent.com/z-galaxy/zlink/3660d731d7de8f60c8d82e122b3ece15617185e4/data/logo.png"
)]
#![deny(
    missing_debug_implementations,
    nonstandard_style,
    rust_2018_idioms,
    missing_docs
)]
#![warn(unreachable_pub)]
// The README examples use the tokio runtime and hence the `tokio`-specific API.
#![cfg_attr(feature = "tokio", doc = include_str!("../README.md"))]
#![cfg_attr(
    not(feature = "tokio"),
    doc = "An asynchronous [Varlink](https://varlink.org/) API. See the \
        [project README](https://github.com/z-galaxy/zlink) for an overview and examples."
)]

#[cfg(not(any(feature = "tokio", feature = "smol")))]
compile_error!("At least one runtime feature must be enabled: 'tokio' or 'smol'");

// The book examples use the tokio runtime and hence the `tokio`-specific API.
#[cfg(all(doctest, feature = "tokio"))]
mod doctests {
    // Book markdown checks.
    doc_comment::doctest!("../../book/src/introduction.md");
    doc_comment::doctest!("../../book/src/concepts.md");
    doc_comment::doctest!("../../book/src/connection.md");
    #[cfg(feature = "proxy")]
    doc_comment::doctest!("../../book/src/client.md");
    #[cfg(feature = "service")]
    doc_comment::doctest!("../../book/src/service.md");
    #[cfg(feature = "proxy")]
    doc_comment::doctest!("../../book/src/pipelining.md");
    doc_comment::doctest!("../../book/src/design.md");
    // The introspection chapter is checked from `zlink-codegen` since its examples depend on that
    // crate, which we can't (dev-)depend on without creating a dependency cycle. Similarly, the
    // embedded chapter is checked from `zlink-core` since its example requires the `no_std`
    // variants of the socket traits.
    doc_comment::doctest!("../../book/src/faq.md");
}

pub use zlink_core::*;

/// API specific to the [tokio](https://tokio.rs/) runtime.
#[cfg(feature = "tokio")]
pub mod tokio {
    #[cfg(feature = "server")]
    pub use zlink_tokio::notified;
    pub use zlink_tokio::unix;
}

/// API specific to the [smol](https://github.com/smol-rs/smol) runtime.
#[cfg(feature = "smol")]
pub mod smol {
    #[cfg(feature = "server")]
    pub use zlink_smol::notified;
    pub use zlink_smol::unix;
}