kinjo 0.1.2

Kinjo: mDNS TUI and commands launch for local network services
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

//! Discovery: the producer of [`Entry`] values.
//!
//! A discovery backend streams [`DiscoveryEvent`]s as entries appear, disappear,
//! or status changes. [`Entry`] is the contract type shared with the rest of the
//! program — swapping in a different backend (e.g. a non-mDNS DNS-SD source)
//! only requires implementing [`Discovery`] and producing `Entry` values.

mod entry;
mod fake;
mod mdns;
mod worker;
#[cfg(feature = "zeroconf")]
mod zeroconf;

use std::sync::mpsc;

pub use entry::{Entry, EntryGroup, EntryId, GroupingMode, decode_dns_sd_escapes, group_entries};

/// The mDNS/DNS-SD library used to discover services.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum DiscoveryBackend {
    /// `mdns-sd-discovery`: a single browser enumerates every service type via
    /// the native DNS-SD meta-query. This is the default.
    #[default]
    MdnsSd,
    /// `zeroconf`: wraps the system Avahi/Bonjour stack, sweeping a curated set
    /// of common service types in parallel. Only available when the crate is
    /// built with the `zeroconf` feature.
    #[cfg(feature = "zeroconf")]
    Zeroconf,
}

/// An event emitted by a discovery backend.
#[derive(Debug, Clone)]
pub enum DiscoveryEvent {
    /// An entry appeared or its attributes changed.
    Upsert(Entry),
    /// An entry went away.
    Remove(EntryId),
    /// A human-readable status update about the discovery process.
    Status(String),
}

/// Inputs a discovery backend needs. Keeps the discovery layer decoupled from
/// the CLI/UI layer (see [`crate::ui::cli::Cli::discovery_config`]).
#[derive(Debug, Clone)]
pub struct DiscoveryConfig {
    /// Use the built-in sample records instead of real mDNS discovery.
    pub fake: bool,
    /// Which mDNS/DNS-SD library to discover with when `fake` is unset.
    pub backend: DiscoveryBackend,
    /// DNS-SD domain to browse.
    pub domain: String,
    /// Limit discovery to a single DNS-SD service type, if set.
    pub service_type: Option<String>,
}

/// A swappable source of [`DiscoveryEvent`]s.
pub trait Discovery {
    /// Take the event receiver. Callable once.
    fn events(&mut self) -> mpsc::Receiver<DiscoveryEvent>;
}

/// Construct the discovery backend selected by `config`.
pub fn start(config: &DiscoveryConfig) -> Box<dyn Discovery> {
    if config.fake {
        return Box::new(fake::FakeDiscovery::start(config));
    }
    match config.backend {
        DiscoveryBackend::MdnsSd => Box::new(mdns::start(config)),
        #[cfg(feature = "zeroconf")]
        DiscoveryBackend::Zeroconf => Box::new(zeroconf::start(config)),
    }
}