Enum StorageError 

pub enum StorageError {
    Api {
        status: StatusCode,
        body: ApiErrorBody,
    },
    InvalidPath {
        path: String,
        reason: PathError,
    },
    InvalidBaseUrl,
    MissingSignedToken(String),
    SignFailed {
        path: String,
        message: String,
    },
    Url(ParseError),
    Http(Error),
    Json(Error),
    InvalidHeader(InvalidHeaderValue),
}

Errors returned by StorageClient and Bucket.

Variants

Api

The Storage API answered with a non-success HTTP status.

Fields

status: StatusCode

HTTP status of the response.

body: ApiErrorBody

Decoded response body.

InvalidPath

A bucket id or object path is not valid.

Fields

path: String

The rejected input.

reason: PathError

Why the input was rejected.

InvalidBaseUrl

The project URL cannot carry path segments (for example mailto:).

MissingSignedToken(String)

The Storage API returned a signed URL without a ?token= query.

SignFailed

The Storage API did not sign an object, for example because it does not exist or the caller cannot read it.

Fields

path: String

The requested object path.

message: String

The reason from the Storage API.

Url(ParseError)

A URL could not be parsed or joined.

Http(Error)

The HTTP transport failed.

Json(Error)

A success response body is not the expected JSON.

InvalidHeader(InvalidHeaderValue)

A key, token, or option is not a valid HTTP header value.

Implementations

impl StorageError

pub fn api_status(&self) -> Option<StatusCode>

Status the Storage API reports for an StorageError::Api error, None for other errors.

The object routes answer most errors with HTTP 400 and put the real status in the body’s statusCode, for example "404" for a missing object and "403" when row level security denies access. This returns the body status when it is a valid status code and the HTTP status otherwise.

pub const fn code(&self) -> Option<&StorageErrorCode>

Machine-readable code of an StorageError::Api error body, None for other errors and for bodies without a code.

For example, an upload without upsert to an existing path fails with StorageErrorCode::KeyAlreadyExists or StorageErrorCode::ResourceAlreadyExists, and a delete that row level security blocks fails with StorageErrorCode::AccessDenied.

Trait Implementations

impl Debug for StorageError

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

Formats the value using the given formatter.

impl Display for StorageError

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

Formats the value using the given formatter.

impl Error for StorageError

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 StorageError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for StorageError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderValue> for StorageError

fn from(source: InvalidHeaderValue) -> Self

Converts to this type from the input type.

impl From<ParseError> for StorageError

fn from(source: ParseError) -> Self

Converts to this type from the input type.