bee-rest-api 0.1.7

The default REST API implementation for the IOTA Bee node software.
Documentation 
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

// Copyright 2020-2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use serde::{Deserialize, Serialize};

/// A marker trait to represent the data that can be included into `SuccessBody` and `ErrorBody`.
pub trait BodyInner {}

/// Describes the response body of a successful HTTP request.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct SuccessBody<T: BodyInner> {
    pub data: T,
}

impl<T: BodyInner> SuccessBody<T> {
    pub fn new(data: T) -> Self {
        Self { data }
    }
}

/// Describes the response body of a unsuccessful HTTP request.
#[derive(Clone, Debug, Serialize)]
pub struct ErrorBody<T: BodyInner> {
    pub error: T,
}

impl<T: BodyInner> ErrorBody<T> {
    pub fn new(error: T) -> Self {
        Self { error }
    }
}

/// Describes the default error format.
#[derive(Clone, Debug, Serialize)]
pub struct DefaultErrorResponse {
    pub code: String,
    pub message: String,
}

impl BodyInner for DefaultErrorResponse {}