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

//! The ngrok agent SDK.

#![warn(missing_docs)]

mod internals {
    #[macro_use]
    pub mod rpc;
    pub mod proto;
    pub mod raw_session;
}

/// Tunnel and endpoint configuration types.
pub mod config {
    // TODO: remove this once all of the config structs are fully fleshed out
    //       and tested.
    #![allow(dead_code)]

    #[macro_use]
    mod common;
    pub use common::*;

    mod headers;
    mod http;
    pub use http::*;
    mod labeled;
    pub use labeled::*;
    mod oauth;
    pub use oauth::*;
    mod oidc;
    pub use oidc::*;
    mod tcp;
    pub use tcp::*;
    mod tls;
    pub use tls::*;
    mod webhook_verification;
}

/// Types for working with the ngrok session.
pub mod session;
/// Types for working with ngrok tunnels.
pub mod tunnel;

mod tunnel_ext;

#[doc(inline)]
pub use session::Session;
#[doc(inline)]
pub use tunnel::{
    Conn,
    Tunnel,
};

/// A prelude of traits for working with ngrok types.
pub mod prelude {
    #[doc(inline)]
    pub use crate::{
        config::TunnelBuilder,
        tunnel::{
            LabelsTunnel,
            ProtoTunnel,
            Tunnel,
            UrlTunnel,
        },
        tunnel_ext::TunnelExt,
    };
}

#[cfg(all(test, feature = "online-tests"))]
mod online_tests;