Skip to main content

kodik_api/
error.rs

1//! Ошибки, возвращаемые библиотекой.
2
3use std::time::Duration;
4
5/// Результат операции библиотеки Kodik API.
6pub type Result<T> = std::result::Result<T, Error>;
7
8/// Ошибка, возникшая при подготовке или выполнении запроса к Kodik API.
9///
10/// Варианты с вложенной ошибкой используют `#[from]`, поэтому операторы `?` в
11/// клиенте автоматически сохраняют исходную причину как `source()`.
12#[derive(Debug, thiserror::Error)]
13pub enum Error {
14    /// Параметры запроса не прошли локальную валидацию.
15    #[error("invalid Kodik request: {0}")]
16    Validation(String),
17
18    /// URI не может быть представлен типом `hyper::Uri`.
19    #[error("invalid request URI: {0}")]
20    InvalidUri(#[from] hyper::http::uri::InvalidUri),
21
22    /// Не удалось собрать HTTP-запрос.
23    #[error("could not build HTTP request: {0}")]
24    RequestBuild(#[from] hyper::http::Error),
25
26    /// TLS-соединение, сеть или HTTP-протокол вернули ошибку.
27    #[error("Kodik HTTP transport error: {0}")]
28    Transport(#[from] hyper::Error),
29
30    /// Полный HTTP-запрос (получение заголовков и тела) не завершился за отведённое время.
31    #[error("Kodik HTTP request did not complete within {} ms", .0.as_millis())]
32    Timeout(Duration),
33
34    /// Ответ превысил настроенное ограничение, поэтому его чтение было остановлено.
35    #[error("Kodik HTTP response exceeded the configured {limit}-byte body limit")]
36    ResponseBodyTooLarge {
37        /// Максимально допустимый размер тела в байтах.
38        limit: usize,
39    },
40
41    /// Тело ответа нельзя разобрать как JSON.
42    #[error("could not decode Kodik JSON response: {0}")]
43    Json(#[from] simd_json::Error),
44
45    /// Сервер вернул HTTP-статус вне успешного диапазона `2xx`.
46    #[error("Kodik API returned HTTP {status}: {body}")]
47    HttpStatus {
48        /// Числовой HTTP-статус.
49        status: u16,
50        /// Тело ответа, декодированное с потерями UTF-8 только для диагностики.
51        body: String,
52    },
53}