hick-reactor 0.2.0

Async mDNS driver layered on `mdns-proto` + `hick-udp`, runtime-agnostic via `agnostic-net` (tokio & smol).
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

#![doc = include_str!("../README.md")]
#![cfg_attr(not(test), forbid(unsafe_code))]
#![cfg_attr(test, deny(unsafe_code))]
#![deny(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(docsrs, allow(unused_attributes))]

mod command;
mod discovery;
mod driver;
mod endpoint;
mod error;
mod options;
mod proto;
mod query;
mod service;
#[cfg(all(test, feature = "tracing", not(miri)))]
mod trace_cov;

pub use discovery::{Lookup, QueryParam, ServiceEntry};
pub use endpoint::Endpoint;
pub use error::{CancelError, RegisterError, ServerError, StartQueryError};
pub use options::ServerOptions;
pub use query::{Query, QueryEvent};
pub use service::Service;

// Re-export the mdns-proto types callers need to interact with this crate.
pub use mdns_proto::{
  CollectedAnswer, EndpointConfig, Name, QueryHandle, QuerySpec, ServiceHandle, ServiceRecords,
  ServiceRenamed, ServiceSpec, ServiceUpdate, config, error as proto_error, event, wire,
};

/// Per-runtime adapter for the [`tokio`] runtime.
#[cfg(feature = "tokio")]
#[cfg_attr(docsrs, doc(cfg(feature = "tokio")))]
pub mod tokio {
  use crate::options::ServerOptions;

  /// `tokio`-backed mDNS [`Endpoint`](crate::Endpoint).
  pub type Endpoint = crate::Endpoint;

  /// Construct an mDNS endpoint pinned to the `tokio` runtime.
  ///
  /// Equivalent to [`crate::Endpoint::server::<agnostic_net::tokio::Net>`].
  #[inline]
  pub async fn server(opts: ServerOptions) -> Result<Endpoint, crate::ServerError> {
    Endpoint::server::<agnostic_net::tokio::Net>(opts).await
  }
}

/// Per-runtime adapter for the [`smol`] runtime.
#[cfg(feature = "smol")]
#[cfg_attr(docsrs, doc(cfg(feature = "smol")))]
pub mod smol {
  use crate::options::ServerOptions;

  /// `smol`-backed mDNS [`Endpoint`](crate::Endpoint).
  pub type Endpoint = crate::Endpoint;

  /// Construct an mDNS endpoint pinned to the `smol` runtime.
  ///
  /// Equivalent to [`crate::Endpoint::server::<agnostic_net::smol::Net>`].
  #[inline]
  pub async fn server(opts: ServerOptions) -> Result<Endpoint, crate::ServerError> {
    Endpoint::server::<agnostic_net::smol::Net>(opts).await
  }
}