cratery 1.11.1

Cratery -- a private cargo registry
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

/*******************************************************************************
 * Copyright (c) 2024 Cénotélie Opérations SAS (cenotelie.fr)
******************************************************************************/

//! Utility APIs for axum

pub mod auth;
pub mod embedded;
pub mod extractors;
pub mod sse;

use axum::http::StatusCode;
use axum::Json;
use log::error;

use crate::utils::apierror::ApiError;

/// Defines an API response
pub type ApiResult<T> = Result<(StatusCode, Json<T>), (StatusCode, Json<ApiError>)>;

/// Produces an error response
///
/// # Panics
///
/// Panic when the HTTP code is not a correct status code
pub fn response_error_http(http: u16, error: ApiError) -> (StatusCode, Json<ApiError>) {
    if http == 500 {
        // log internal errors
        error!("{}", error);
        if let Some(backtrace) = &error.backtrace {
            error!("{}", backtrace);
        }
    }
    (StatusCode::from_u16(http).unwrap(), Json(error))
}

/// Produces an error response
pub fn response_error(error: ApiError) -> (StatusCode, Json<ApiError>) {
    response_error_http(error.http, error)
}

/// Produces an OK response
///
/// # Panics
///
/// Panic when the HTTP code is not a correct status code
pub fn response_ok_http<T>(http: u16, data: T) -> (StatusCode, Json<T>) {
    (StatusCode::from_u16(http).unwrap(), Json(data))
}

/// Produces an OK response
pub fn response_ok<T>(data: T) -> (StatusCode, Json<T>) {
    response_ok_http(200, data)
}

/// Maps a service result to a web api result
///
/// # Errors
///
/// Maps the corresponding error from the given `Result`.
pub fn response<T>(result: Result<T, ApiError>) -> ApiResult<T> {
    result.map_err(response_error).map(response_ok)
}