agnostic 0.11.0

An agnostic abstraction layer for any async runtime.
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

#![doc = include_str!("../README.md")]
#![cfg_attr(not(feature = "std"), no_std)]
#![deny(warnings, missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(docsrs, allow(unused_attributes))]
#![allow(clippy::needless_return)]
#![allow(unreachable_code)]

#[cfg(all(feature = "alloc", not(feature = "std")))]
extern crate alloc as std;

#[cfg(feature = "std")]
extern crate std;

pub use runtime::*;

/// The runtime related traits and types
mod runtime {
  pub use agnostic_lite::{
    AfterHandle, AfterHandleError, AsyncAfterSpawner, AsyncBlockingSpawner, AsyncLocalSpawner,
    AsyncSpawner, JoinHandle, LocalJoinHandle, LocalRuntimeLite, RuntimeLite, Yielder, cfg_linux,
    cfg_smol, cfg_tokio, cfg_unix, cfg_windows, time,
  };

  /// Runtime trait
  pub trait Runtime: RuntimeLite {
    /// The network abstraction for this runtime
    #[cfg(feature = "net")]
    #[cfg_attr(docsrs, doc(cfg(feature = "net")))]
    type Net: super::net::Net;

    /// The process abstraction for this runtime
    #[cfg(feature = "process")]
    #[cfg_attr(docsrs, doc(cfg(feature = "process")))]
    type Process: super::process::Process;

    /// The Quinn abstraction for this runtime
    #[cfg(feature = "quinn")]
    #[cfg_attr(docsrs, doc(cfg(feature = "quinn")))]
    type Quinn: super::quinn::QuinnRuntime;

    /// Returns the runtime for [`quinn`](::quinn)
    #[cfg(feature = "quinn")]
    #[cfg_attr(docsrs, doc(cfg(feature = "quinn")))]
    fn quinn() -> Self::Quinn;
  }
}

/// Traits, helpers, and type definitions for asynchronous I/O functionality.
pub use agnostic_io as io;

/// [`tokio`] runtime adapter
///
/// [`tokio`]: https://docs.rs/tokio
#[cfg(feature = "tokio")]
#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
pub mod tokio;

/// [`smol`] runtime adapter
///
/// [`smol`]: https://docs.rs/smol
#[cfg(feature = "smol")]
#[cfg_attr(docsrs, doc(cfg(feature = "smol")))]
pub mod smol;

/// Network related traits
#[cfg(feature = "net")]
#[cfg_attr(docsrs, doc(cfg(feature = "net")))]
pub mod net;

/// Agnostic async DNS provider.
#[cfg(feature = "dns")]
#[cfg_attr(docsrs, doc(cfg(feature = "dns")))]
pub mod dns {
  pub use agnostic_dns::{
    AgnosticTime, AsyncConnectionProvider, AsyncDnsUdp, AsyncRuntimeProvider, AsyncSpawn,
    CLOUDFLARE, Dns, GOOGLE, LookupIpStrategy, NameServerConfig, ProtocolConfig, QUAD9,
    ResolverConfig, ResolverOpts, ServerGroup, ServerOrderingStrategy, Timer,
  };

  #[cfg(any(unix, windows))]
  #[cfg_attr(docsrs, doc(cfg(any(unix, windows))))]
  pub use agnostic_dns::read_system_conf;

  #[cfg(all(unix, not(target_os = "android"), not(target_vendor = "apple")))]
  #[cfg_attr(
    docsrs,
    doc(cfg(all(unix, not(target_os = "android"), not(target_vendor = "apple"))))
  )]
  pub use agnostic_dns::{parse_resolv_conf, read_resolv_conf};
}

/// Quinn related traits
#[cfg(feature = "quinn")]
#[cfg_attr(docsrs, doc(cfg(feature = "quinn")))]
pub mod quinn;

/// Process related traits
#[cfg(feature = "process")]
#[cfg_attr(docsrs, doc(cfg(feature = "process")))]
pub mod process;