ngrok/
lib.rs

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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
#![doc = include_str!("../README.md")]
#![warn(missing_docs)]
#![cfg_attr(docsrs, feature(doc_cfg))]

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

/// Tunnel and endpoint configuration types.
pub mod config {
    #[macro_use]
    mod common;
    pub use common::*;

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

mod proxy_proto;

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

/// Types for working with ngrok connections.
pub mod conn;

/// Types for working with connection forwarders.
pub mod forwarder;
mod tunnel_ext;

#[doc(inline)]
pub use conn::{
    Conn,
    EdgeConn,
    EndpointConn,
};
#[doc(inline)]
pub use internals::proto::Error;
#[doc(inline)]
pub use session::Session;
#[doc(inline)]
pub use tunnel::Tunnel;

/// A prelude of traits for working with ngrok types.
pub mod prelude {
    #[allow(deprecated)]
    #[doc(inline)]
    pub use crate::{
        config::{
            Action,
            ForwarderBuilder,
            HttpTunnelBuilder,
            InvalidPolicy,
            LabeledTunnelBuilder,
            OauthOptions,
            OidcOptions,
            Policy,
            ProxyProto,
            Rule,
            Scheme,
            TcpTunnelBuilder,
            TlsTunnelBuilder,
            TunnelBuilder,
        },
        conn::{
            Conn,
            ConnInfo,
            EdgeConnInfo,
            EndpointConnInfo,
        },
        internals::proto::EdgeType,
        internals::proto::Error,
        tunnel::{
            EdgeInfo,
            EndpointInfo,
            Tunnel,
            TunnelCloser,
            TunnelInfo,
        },
        tunnel_ext::TunnelExt,
    };
}

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