libduvet/error

Types

ApiFailure

pub type ApiFailure {
  ApiFailure(
    action: String,
    status_code: Int,
    body: option.Option(String),
  )
}

Constructors

ApiFailure(
  action: String,
  status_code: Int,
  body: option.Option(String),
)

AuthFailure

</>

pub type AuthFailure {
  AuthFailure(
    action: String,
    status_code: Int,
    body: option.Option(String),
  )
}

Constructors

AuthFailure(
  action: String,
  status_code: Int,
  body: option.Option(String),
)

DuvetError

</>

Everything a request can fail with. Dart’s package throws exceptions; here every call answers a Result, and the failure carries what the exception carried.

pub type DuvetError {
  ApiError(failure: ApiFailure)
  AuthError(failure: AuthFailure)
  RequestTimeout(method: String, path: String, timeout_ms: Int)
  RequestAborted
  NetworkError(reason: String)
  MalformedMessage(cause: String)
  InvalidArgument(message: String)
}

Constructors

```
ApiError(failure: ApiFailure)
```
The API answered 2xx-but-an-error, or any status but 401 and 403.
```
AuthError(failure: AuthFailure)
```
The API answered 401 or 403: the session is missing, expired or not allowed.

RequestTimeout(method: String, path: String, timeout_ms: Int)

Nothing moved for the request’s timeout.

```
RequestAborted
```
The caller’s abort trigger completed first.
```
NetworkError(reason: String)
```
The connection failed or was closed.
```
MalformedMessage(cause: String)
```
The API or the gateway sent something this package couldn’t read.
```
InvalidArgument(message: String)
```
The arguments themselves are wrong, and nothing was sent.

Values

api

</>

pub fn api(
  action: String,
  status_code: Int,
  body: String,
) -> DuvetError

auth

</>

pub fn auth(
  action: String,
  status_code: Int,
  body: String,
) -> DuvetError

from_send_error

</>

pub fn from_send_error(error: send.SendError) -> DuvetError

is_aborted

</>

pub fn is_aborted(error: DuvetError) -> Bool

is_timeout

</>

pub fn is_timeout(error: DuvetError) -> Bool

message

</>

pub fn message(error: DuvetError) -> String

The failure’s message, as the Dart exception’s message reads.

status_code

</>

pub fn status_code(error: DuvetError) -> option.Option(Int)

to_string

</>

pub fn to_string(error: DuvetError) -> String

The failure’s text, as the Dart exception’s toString reads (for logs).