Enum ConnectError 

#[non_exhaustive]
pub enum ConnectError {
    Tcp(Error),
    Tls(Error),
    Start(StartSessionError),
    Auth(RpcError),
    Rebind(RpcError),
    ProxyConnect(Box<dyn Error + Send + Sync + 'static>),
    Canceled,
}

Errors arising at SessionBuilder::connect time.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Tcp(Error)

An error occurred when establishing a TCP connection to the ngrok server.

Tls(Error)

A TLS handshake error occurred.

This is usually a certificate validation issue, or an attempt to connect to something that doesn’t actually speak TLS.

Start(StartSessionError)

An error occurred when starting the ngrok session.

This might occur when there’s a protocol mismatch interfering with the heartbeat routine.

Auth(RpcError)

An error occurred when attempting to authenticate.

Rebind(RpcError)

An error occurred when rebinding tunnels during a reconnect

ProxyConnect(Box<dyn Error + Send + Sync + 'static>)

An error arising from a failure to connect through a proxy.

Canceled

The (re)connect function gave up.

This will never be returned by the default connect function, and is instead used to cancel the reconnect loop.

Trait Implementations

impl Debug for ConnectError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ConnectError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ConnectError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl Error for ConnectError

fn error_code(&self) -> Option<&str>

Return the ngrok error code, if one exists for this error.

fn msg(&self) -> String

Return the error message minus the ngrok error code. If this error has no error code, this is equivalent to format!("{error}").