Enum Error 

#[non_exhaustive]
pub enum Error {
    CredentialRead {
        path: PathBuf,
        source: Error,
    },
    InvalidCertificate {
        path: PathBuf,
        reason: &'static str,
    },
    InvalidPrivateKey {
        path: PathBuf,
        reason: &'static str,
    },
    Transport(Error),
    GrpcStatus(Status),
    InvalidGatewayAddress,
    InvalidDeviceUrl,
    UnsupportedAuthSigningKey,
    AuthSigning,
    MissingTokenDeadline,
    InvalidTokenDeadline,
    InvalidAuthTokenMetadata,
    ServiceStatusUnsupported,
    InvalidRemoteSocksEndpoint,
    ServiceAddressLookup {
        source: Error,
    },
    ServiceAddressNoRoute {
        source: Option<Error>,
    },
    InvalidSocksAddress,
    SocksAddressTooLong,
    UnsupportedSocksAddressType {
        address_type: u8,
    },
    RemoteSocksIo(Error),
    RemoteSocksTimeout,
    UnexpectedSocksVersion {
        version: u8,
    },
    SocksNoAcceptableAuthentication,
    UnsupportedSocksAuthentication {
        method: u8,
    },
    InvalidSocksReservedByte {
        reserved: u8,
    },
    SocksReply {
        code: u8,
    },
    InvalidSocksUdpHeader,
    UnsupportedSocksUdpFragment {
        fragment: u8,
    },
    SocksUdpPayloadTooLarge,
    SocksUdpNotConnected,
    RemoteSocksControlClosed,
    InvalidSocksUdpAddress,
    InvalidMetadataValue(InvalidMetadataValue),
    UnauthenticatedPeer,
    InvalidPeerCertificateCount {
        count: usize,
    },
    InvalidPeerCertificate,
}

Errors returned by the LazyCat SDK compatibility layer.

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.

CredentialRead

A runtime credential could not be read.

Fields

path: PathBuf

Credential path that failed.

source: Error

Underlying I/O failure.

InvalidCertificate

A certificate file was empty, malformed, or unsupported.

Fields

path: PathBuf

Certificate path that failed validation.

reason: &'static str

Sanitized validation reason.

InvalidPrivateKey

A private key file was empty, malformed, unsupported, or mismatched.

Fields

path: PathBuf

Private key path that failed validation.

reason: &'static str

Sanitized validation reason.

Transport(Error)

A tonic channel could not be configured or connected.

GrpcStatus(Status)

A gRPC method returned a status response.

InvalidGatewayAddress

The runtime gateway override is not a host or HTTP(S) URI.

InvalidDeviceUrl

A device API URL is malformed or uses an unsupported scheme.

UnsupportedAuthSigningKey

The application private key cannot produce Go-compatible auth signatures.

AuthSigning

Signing the application identity failed.

MissingTokenDeadline

The device returned a token without an expiry deadline.

InvalidTokenDeadline

The device returned an invalid token expiry deadline.

InvalidAuthTokenMetadata

An auth token cannot be encoded as gRPC metadata.

ServiceStatusUnsupported

The device does not implement the optional service-status API.

InvalidRemoteSocksEndpoint

HPortalSys returned a malformed or unsupported RemoteSocks URL.

ServiceAddressLookup

Resolving the LazyCat host-service address failed.

Fields

source: Error

Underlying DNS lookup failure.

ServiceAddressNoRoute

No resolved host-service candidate had a usable local route.

Fields

source: Option<Error>

Last route-selection failure, when at least one candidate was tried.

InvalidSocksAddress

A SOCKS address is malformed or cannot be represented on the wire.

SocksAddressTooLong

A SOCKS domain or custom address exceeds the one-byte wire length.

UnsupportedSocksAddressType

A SOCKS peer used an address type not defined by RFC 1928.

Fields

address_type: u8

Unrecognized wire address type.

RemoteSocksIo(Error)

A network operation used by RemoteSocks failed.

RemoteSocksTimeout

Connecting to the RemoteSocks proxy exceeded the configured deadline.

UnexpectedSocksVersion

A SOCKS peer replied with an unexpected protocol version.

Fields

version: u8

Version byte received from the peer.

SocksNoAcceptableAuthentication

A SOCKS peer rejected every offered authentication method.

UnsupportedSocksAuthentication

A SOCKS peer selected an authentication method this SDK does not support.

Fields

method: u8

Authentication method selected by the peer.

InvalidSocksReservedByte

A SOCKS reply used a non-zero reserved byte.

Fields

reserved: u8

Reserved byte received from the peer.

SocksReply

A SOCKS command failed with the provided RFC 1928 reply code.

Fields

code: u8

SOCKS reply code returned by the peer.

InvalidSocksUdpHeader

A SOCKS UDP datagram had invalid reserved or framing bytes.

UnsupportedSocksUdpFragment

SOCKS UDP fragmentation is not supported by this SDK.

Fields

fragment: u8

Non-zero RFC 1928 fragment byte.

SocksUdpPayloadTooLarge

A UDP payload cannot fit in one transport frame.

SocksUdpNotConnected

An operation requiring a fixed UDP peer was used on a bound socket.

RemoteSocksControlClosed

The RemoteSocks TCP control stream has closed.

InvalidSocksUdpAddress

A SOCKS address cannot be used as a concrete UDP socket address.

InvalidMetadataValue(InvalidMetadataValue)

A value cannot be represented as gRPC metadata.

UnauthenticatedPeer

The request was not received over authenticated TLS.

InvalidPeerCertificateCount

LazyCat application identity requires exactly one peer certificate.

Fields

count: usize

Number of certificates presented by the peer.

InvalidPeerCertificate

The peer certificate could not be decoded as X.509.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Status> for Error

fn from(source: Status) -> Self

Converts to this type from the input type.