Enum ApiError 

pub enum ApiError {
    Transport(Error),
    Status {
        status: u16,
        url: Option<String>,
        lfs_authenticate: Option<String>,
        body: Option<ServerError>,
        retry_after: Option<Duration>,
    },
    Decode(String),
    Url(ParseError),
    CredentialsNotFound {
        url: String,
        detail: Option<String>,
    },
}

Errors returned by the API client.

Variants

Transport(Error)

Network, TLS or connection-level failure.

Status

Server returned a non-success HTTP status.

The Display impl renders 401 and 403 as Authorization error: <url> to match upstream’s lfshttp.defaultError; other statuses fall through to a plain server-side message when a parseable error body is present, otherwise to a generic server returned status N line.

Fields

status: u16

HTTP status code from the server.

url: Option<String>

Request URL the server responded to. Embedded in the Display impl so users can see which endpoint failed.

lfs_authenticate: Option<String>

LFS-Authenticate response header, mirrored verbatim. Only present on 401 responses; signals which auth scheme the server wants.

body: Option<ServerError>

Parsed LFS error body when the response carried one.

retry_after: Option<Duration>

Parsed Retry-After response header.

Some when the server pinned a wait time the caller should honor instead of falling back to exponential backoff. Used by the transfer queue’s batch retry loop.

Decode(String)

JSON body did not match the expected schema.

Url(ParseError)

Failed to construct the request URL from the endpoint.

CredentialsNotFound

git credential couldn’t supply usable credentials for the endpoint.

detail carries the underlying helper-side reason (e.g. credential value for path contains newline: …) when available; absent when every helper just returned “I don’t know”. Format mirrors upstream’s creds.FillCreds.

Fields

url: String

detail: Option<String>

Implementations

impl ApiError

pub fn is_unauthorized(&self) -> bool

true for 401 responses; caller should resolve credentials and retry.

pub fn is_forbidden(&self) -> bool

true for 403 responses; caller lacks permission for this operation.

pub fn is_not_found(&self) -> bool

true for 404 responses.

pub fn is_retryable(&self) -> bool

true for 5xx and 408/429 responses (transient errors a caller may want to retry).

pub fn retry_after(&self) -> Option<Duration>

Server-supplied retry delay, if any.

Pulled from the Retry-After response header at decode time. Mirrors upstream’s errors.NewRetriableLaterError gate; falls back to exponential backoff at the call site when None.

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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> for CreateLockError

fn from(source: ApiError) -> Self

Converts to this type from the input type.

impl From<Error> for ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for ApiError

fn from(source: ParseError) -> Self

Converts to this type from the input type.