Enum ApiError

#[non_exhaustive]
pub enum ApiError<E>
where
    E: Error + Send + Sync + 'static,
{
    Client {
        source: E,
    },
    Auth {
        source: AuthError,
    },
    UrlParse {
        source: ParseError,
    },
    Body {
        source: BodyError,
    },
    Json {
        source: Error,
    },
    MovedPermanently {
        location: Option<String>,
    },
    Gitlab {
        msg: String,
    },
    GitlabService {
        status: StatusCode,
        data: Vec<u8>,
    },
    GitlabObject {
        obj: Value,
    },
    GitlabUnrecognized {
        obj: Value,
    },
    DataType {
        source: Error,
        typename: &'static str,
    },
    Pagination {
        source: PaginationError,
    },
    UnsupportedUrlBase {
        url_base: UrlBase,
    },
    GitlabWithStatus {
        status: StatusCode,
        msg: String,
    },
    GitlabObjectWithStatus {
        status: StatusCode,
        obj: Value,
    },
    GitlabUnrecognizedWithStatus {
        status: StatusCode,
        obj: Value,
    },
    GitlabRateLimited {
        rl_limit: usize,
        rl_name: String,
        rl_observed: usize,
        rl_remaining: usize,
        rl_reset: DateTime<Utc>,
        retry_after: Duration,
    },
}

Errors which may occur when using API endpoints.

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.

Client

The client encountered an error.

Fields

source: E

The client error.

Auth

Authentication failed.

Fields

source: AuthError

The source of the error.

UrlParse

The URL failed to parse.

Fields

source: ParseError

The source of the error.

Body

Body data could not be created.

Fields

source: BodyError

The source of the error.

Json

JSON deserialization from GitLab failed.

Fields

source: Error

The source of the error.

MovedPermanently

The resource has been moved permanently.

Fields

location: Option<String>

The new location for the resource.

Gitlab

👎Deprecated since 0.1705.2: Use GitlabWithStatus instead

GitLab returned an error message.

Fields

msg: String

👎Deprecated since 0.1705.2: Use GitlabWithStatus instead

The error message from GitLab.

GitlabService

GitLab returned an error without JSON information.

Fields

status: StatusCode

The status code for the return.

data: Vec<u8>

The error data from GitLab.

GitlabObject

👎Deprecated since 0.1705.2: Use GitlabObjectWithStatus instead

GitLab returned an error object.

Fields

obj: Value

👎Deprecated since 0.1705.2: Use GitlabObjectWithStatus instead

The error object from GitLab.

GitlabUnrecognized

👎Deprecated since 0.1705.2: Use GitlabUnrecognizedWithStatus instead

GitLab returned an HTTP error with JSON we did not recognize.

Fields

obj: Value

👎Deprecated since 0.1705.2: Use GitlabUnrecognizedWithStatus instead

The full object from GitLab.

DataType

Failed to parse an expected data type from JSON.

Fields

source: Error

The source of the error.

typename: &'static str

The name of the type that could not be deserialized.

Pagination

An error with pagination occurred.

Fields

source: PaginationError

The source of the error.

UnsupportedUrlBase

The client does not understand how to use an endpoint for the given URL base.

Fields

url_base: UrlBase

The URL base that is not supported.

GitlabWithStatus

GitLab returned an error message with an HTTP error.

Fields

status: StatusCode

The HTTP status code.

msg: String

The error message from GitLab.

GitlabObjectWithStatus

GitLab returned an error object with an HTTP error.

Fields

status: StatusCode

The HTTP status code.

obj: Value

The error object from GitLab.

GitlabUnrecognizedWithStatus

GitLab returned an HTTP error with JSON we did not recognize.

Fields

status: StatusCode

The HTTP status code.

obj: Value

The full object from GitLab.

GitlabRateLimited

GitLab returned an error message with an HTTP error.

Fields

rl_limit: usize

The rate limit.

rl_name: String

The name of the rate limit in place.

rl_observed: usize

The number of API usages observed.

rl_remaining: usize

The number of API requests remaining.

rl_reset: DateTime<Utc>

When the rate limit resets.

retry_after: Duration

How long to wait before another request.

Implementations

impl<E> ApiError<E>

where E: Error + Send + Sync + 'static,

pub fn client(source: E) -> Self

Create an API error in a client error.

pub fn map_client<F, W>(self, f: F) -> ApiError<W>

where F: FnOnce(E) -> W, W: Error + Send + Sync + 'static,

Wrap a client error in another wrapper.

Trait Implementations

impl<E> Debug for ApiError<E>

where E: Error + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.

impl<E> Display for ApiError<E>

where E: Error + Send + Sync + 'static,

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

Formats the value using the given formatter.

impl<E> Error for ApiError<E>

where E: Error + Send + Sync + 'static + Error, Self: Debug + Display,

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<ApiError<RestError>> for GitlabError

fn from(source: ApiError<RestError>) -> Self

Converts to this type from the input type.

impl<E> From<AuthError> for ApiError<E>

where E: Error + Send + Sync + 'static,

fn from(source: AuthError) -> Self

Converts to this type from the input type.

impl<E> From<BodyError> for ApiError<E>

where E: Error + Send + Sync + 'static,

fn from(source: BodyError) -> Self

Converts to this type from the input type.

impl<E> From<Error> for ApiError<E>

where E: Error + Send + Sync + 'static,

fn from(source: Error) -> Self

Converts to this type from the input type.

impl<E> From<PaginationError> for ApiError<E>

where E: Error + Send + Sync + 'static,

fn from(source: PaginationError) -> Self

Converts to this type from the input type.

impl<E> From<ParseError> for ApiError<E>

where E: Error + Send + Sync + 'static,

fn from(source: ParseError) -> Self

Converts to this type from the input type.