Enum GitLabError 

pub enum GitLabError {
    Authentication(String),
    Api(String),
    Http(Error),
    NotFound {
        resource: String,
        id: String,
    },
    Config(String),
    Serialization(Error),
    RateLimit {
        retry_after: Option<u64>,
    },
    PermissionDenied(String),
    InvalidInput {
        field: String,
        message: String,
    },
    Timeout {
        seconds: u64,
    },
    Conflict(String),
    ServerError(String),
    Unexpected(String),
}

The main error type for all GitLab client operations.

This enum covers all possible error scenarios including authentication, API errors, network issues, and data validation problems.

Variants

Authentication(String)

Authentication failed due to invalid or missing credentials.

Examples

let error = GitLabError::Authentication("Invalid token".to_string());
assert_eq!(error.to_string(), "Authentication failed: Invalid token");

Api(String)

GitLab API returned an error response.

This includes HTTP error codes, API-specific errors, and malformed responses.

Http(Error)

HTTP request failed due to network or connection issues.

NotFound

Requested resource was not found (HTTP 404).

Examples

let error = GitLabError::NotFound {
    resource: "pipeline".to_string(),
    id: "12345".to_string(),
};

Fields

resource: String

The type of resource (e.g., “pipeline”, “job”, “project”)

id: String

The identifier for the resource

Config(String)

Invalid configuration provided to the client.

This includes invalid URLs, missing required fields, or incompatible settings.

Serialization(Error)

Failed to serialize or deserialize data.

RateLimit

Rate limit exceeded for API requests.

GitLab enforces rate limits on API calls. When exceeded, this error is returned.

Fields

retry_after: Option<u64>

Number of seconds to wait before retrying (if provided by GitLab)

PermissionDenied(String)

Operation is not permitted due to insufficient permissions.

InvalidInput

Invalid input or parameters provided.

Examples

let error = GitLabError::InvalidInput {
    field: "status".to_string(),
    message: "Must be one of: success, failed, running".to_string(),
};

Fields

field: String

The field name that has invalid input

message: String

Description of why the input is invalid

Timeout

Operation timed out.

This can occur when waiting for a pipeline to complete, polling for status, etc.

Fields

seconds: u64

Number of seconds elapsed before timeout

Conflict(String)

The underlying GitLab API returned a status that indicates a conflict (HTTP 409).

Common scenarios include attempting to create a resource that already exists.

ServerError(String)

The GitLab server is unavailable or returned an error (HTTP 5xx).

Unexpected(String)

An unexpected or unknown error occurred.

This is used as a catch-all for errors that don’t fit other categories.

Implementations

impl GitLabError

pub fn authentication<S: Into<String>>(msg: S) -> Self

Creates an authentication error.

Examples

let error = GitLabError::authentication("Token expired");

pub fn api<S: Into<String>>(msg: S) -> Self

Creates an API error.

Examples

let error = GitLabError::api("Invalid project path");

pub fn not_found<S: Into<String>, I: Display>(resource: S, id: I) -> Self

Creates a not found error.

Examples

let error = GitLabError::not_found("pipeline", 12345);

pub fn config<S: Into<String>>(msg: S) -> Self

Creates a configuration error.

Examples

let error = GitLabError::config("Missing API token");

pub fn rate_limit(retry_after: Option<u64>) -> Self

Creates a rate limit error.

Examples

let error = GitLabError::rate_limit(Some(60));

pub fn permission_denied<S: Into<String>>(msg: S) -> Self

Creates a permission denied error.

Examples

let error = GitLabError::permission_denied("Cannot delete protected branch");

pub fn invalid_input<S: Into<String>, M: Into<String>>( field: S, message: M, ) -> Self

Creates an invalid input error.

Examples

let error = GitLabError::invalid_input("ref", "Branch name cannot be empty");

pub fn timeout(seconds: u64) -> Self

Creates a timeout error.

Examples

let error = GitLabError::timeout(300);

pub fn conflict<S: Into<String>>(msg: S) -> Self

Creates a conflict error.

Examples

let error = GitLabError::conflict("Pipeline already exists");

pub fn server_error<S: Into<String>>(msg: S) -> Self

Creates a server error.

Examples

let error = GitLabError::server_error("Internal server error");

pub fn unexpected<S: Into<String>>(msg: S) -> Self

Creates an unexpected error.

Examples

let error = GitLabError::unexpected("Unknown error occurred");

pub fn is_retryable(&self) -> bool

Returns true if this error is retryable.

Retryable errors include network issues, rate limits, and server errors.

Examples

let error = GitLabError::rate_limit(Some(60));
assert!(error.is_retryable());

let error = GitLabError::not_found("pipeline", 123);
assert!(!error.is_retryable());

pub fn is_client_error(&self) -> bool

Returns true if this is a client error (4xx status codes).

Client errors indicate problems with the request that cannot be resolved by retrying.

pub fn is_server_error(&self) -> bool

Returns true if this is a server error (5xx status codes).

Trait Implementations

impl Debug for GitLabError

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

Formats the value using the given formatter.

impl Display for GitLabError

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

Formats the value using the given formatter.

impl Error for GitLabError

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 GitLabError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for GitLabError

fn from(source: Error) -> Self

Converts to this type from the input type.