ts_control 0.2.0

tailscale control client
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

#![doc = include_str!("../README.md")]

extern crate alloc;

/// Package version of `ts_control` as reported by cargo.
// TODO(npry): this is used to populate Hostinfo.ipn_version, which requests "long format":
//  attach build info and whatever else that entails
const PKG_VERSION: &str = if let Some(version) = option_env!("CARGO_PKG_VERSION") {
    version
} else {
    ""
};

mod config;
mod control_dialer;
mod derp;
mod dial_plan;
#[cfg_attr(not(feature = "async_tokio"), expect(dead_code))]
mod map_request_builder;
mod node;
#[cfg(feature = "async_tokio")]
mod tokio;

#[doc(inline)]
pub use config::{Config, DEFAULT_CONTROL_SERVER};
pub use control_dialer::{ControlDialer, TcpDialer, complete_connection};
pub use derp::{Map as DerpMap, Region as DerpRegion, convert_derp_map};
pub use dial_plan::{DialCandidate, DialMode, DialPlan};
pub use node::{Id as NodeId, Node, StableId as StableNodeId, TailnetAddress};

#[cfg(feature = "async_tokio")]
pub use crate::tokio::{AsyncControlClient, AuthResult, FilterUpdate, PeerUpdate, StateUpdate};

/// Errors that may occur while communicating with control.
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Error connecting to control.
    #[error(transparent)]
    #[cfg(feature = "async_tokio")]
    Connect(#[from] tokio::ConnectionError),
    /// Error processing streaming netmap results.
    #[error(transparent)]
    #[cfg(feature = "async_tokio")]
    MapStream(#[from] tokio::MapStreamError),
    /// Error executing a ping.
    #[error(transparent)]
    #[cfg(feature = "async_tokio")]
    Ping(#[from] tokio::PingError),
    /// Error registering with control.
    #[error(transparent)]
    #[cfg(feature = "async_tokio")]
    Register(#[from] tokio::RegistrationError),
}