Enum Error 

#[non_exhaustive]
pub enum Error {
    Request(Error),
    NotAuthenticated,
    InvalidDataSource(String),
    InvalidUsername(String),
    InvalidConnectionId(String),
    InvalidSharingProfileId(String),
    InvalidUserGroupId(String),
    InvalidConnectionGroupId(String),
    InvalidTunnelId(String),
    InvalidToken(String),
    InvalidQueryParam {
        name: String,
        reason: String,
    },
    Unauthorized {
        body: String,
    },
    Forbidden {
        body: String,
    },
    NotFound {
        resource: String,
        body: String,
    },
    RateLimited {
        retry_after: Option<Duration>,
    },
    Api {
        status: StatusCode,
        body: String,
    },
}

Errors returned by the Guacamole client.

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.

Request(Error)

An underlying HTTP request failed.

NotAuthenticated

No authentication token is available; call login() first.

InvalidDataSource(String)

The supplied data source name is invalid.

InvalidUsername(String)

The supplied username is invalid.

InvalidConnectionId(String)

The supplied connection ID is invalid.

InvalidSharingProfileId(String)

The supplied sharing profile ID is invalid.

InvalidUserGroupId(String)

The supplied user group ID is invalid.

InvalidConnectionGroupId(String)

The supplied connection group ID is invalid.

InvalidTunnelId(String)

The supplied tunnel ID is invalid.

InvalidToken(String)

The authentication token is invalid (contains unsafe characters).

InvalidQueryParam

A query parameter value is invalid (contains unsafe characters).

Fields

name: String

Name of the query parameter.

reason: String

Reason the value was rejected.

Unauthorized

The API returned 401 Unauthorized.

Fields

body: String

Response body from the server.

Forbidden

The API returned 403 Forbidden.

Fields

body: String

Response body from the server.

NotFound

The requested resource was not found (404).

Fields

resource: String

Name of the resource that was not found.

body: String

Response body from the server.

RateLimited

The API returned 429 Too Many Requests.

Fields

retry_after: Option<Duration>

Value of the Retry-After header, if present.

Api

Any other non-success HTTP status code.

Fields

status: StatusCode

HTTP status code.

body: String

Response body from the server.

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.