mdns-sd-discovery 0.2.1

Async wrapper for native DNS-SD/mDNS service discovery
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

#![warn(missing_docs)]
#![warn(unused_extern_crates, unused_qualifications)]

//! Access the operating system's built-in
//! [DNS-SD](https://en.wikipedia.org/wiki/Zero-configuration_networking#DNS-based_service_discovery) /
//! [mDNS](https://en.wikipedia.org/wiki/Multicast_DNS) stack for service
//! discovery.
//!
//! This crate provides a cross-platform async API (using [Tokio](https://tokio.rs)) for
//! browsing DNS-SD services via the native OS facilities:
//!
//! - **macOS**: native [DNS-SD framework](https://developer.apple.com/documentation/dnssd) (available since macOS 10.12)
//! - **Windows**: native [Win32 DNS-SD API](https://learn.microsoft.com/en-us/uwp/api/windows.networking.servicediscovery.dnssd?view=winrt-28000) (available since Windows 10)
//! - **Linux/FreeBSD**: [Avahi](https://avahi.org) via D-Bus (no binary dependency on libavahi)
//!
//! Service registration lives in a separate crate.
//!
//! # Discovery
//!
//! By default a [`ServiceBrowser`] discovers every service type on the network.
//! Filter on [`DiscoveredService::service_type`], or narrow to a single type
//! with [`ServiceBrowserBuilder::service_type`].
//!
//! ```no_run
//! use mdns_sd_discovery::{BrowseEvent, ServiceBrowserBuilder};
//!
//! # async fn example() -> Result<(), Box<dyn std::error::Error>> {
//! let mut browser = ServiceBrowserBuilder::new().browse().await?;
//!
//! while let Some(event) = browser.recv().await {
//!     match event? {
//!         BrowseEvent::Found(svc) => {
//!             println!("+ [{}] {} at {}:{}", svc.service_type, svc.name, svc.host_name, svc.port);
//!         }
//!         BrowseEvent::Removed(svc) => println!("- [{}] {}", svc.service_type, svc.name),
//!     }
//! }
//! // Dropping `browser` stops the browse.
//! # Ok(())
//! # }
//! ```

pub use self::browse::*;

mod browse;

/// Wire-format parsing internals re-exported for the fuzz targets in `fuzz/`.
///
/// `cargo fuzz` builds the whole graph with `--cfg fuzzing`; on regular builds
/// this module does not exist. It is **not** part of the public API.
#[cfg(fuzzing)]
#[doc(hidden)]
pub mod fuzzing {
    use crate::TxtRecord;

    /// Parses a single `key[=value]` TXT entry. See `browse::parse_txt_entry`.
    pub fn parse_txt_entry(entry: &[u8]) -> TxtRecord {
        crate::browse::parse_txt_entry(entry)
    }

    /// Parses a packed, length-prefixed DNS-SD TXT record buffer.
    /// See `browse::parse_txt_buffer`.
    pub fn parse_txt_buffer(buf: &[u8]) -> Vec<TxtRecord> {
        crate::browse::parse_txt_buffer(buf)
    }

    /// Strips trailing `.` characters from a DNS name. See `browse::trim_dot`.
    pub fn trim_dot(s: &str) -> String {
        crate::browse::trim_dot(s)
    }
}

#[cfg(all(unix, not(target_os = "macos")))]
mod linux;
#[cfg(target_os = "macos")]
mod macos;
#[cfg(target_os = "windows")]
mod windows;