api_builder 0.1.2

A simple client-agnostic API builder, inspired by the GitLab crate
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
41
42
43
44
45
46
47

use core::future::Future;

use bytes::Bytes;
use http::{Request, Response};
use url::Url;

use crate::APIError;

#[cfg(feature = "reqwest")]
import!(reqwest);
#[cfg(target_family = "wasm")]
#[cfg(not(feature = "reqwest"))]
import!(wasm);

/// A trait representing a client which can communicate with an instance via REST.
pub trait RestClient {
    /// The errors which may occur for this client.
    type Error;

    /// Get the URL for the endpoint for the client.
    ///
    /// This method adds the hostname for the client's target instance.
    fn rest_endpoint(&self, path: &str) -> Result<Url, APIError<Self::Error>>;
}

/// A trait representing a client.
pub trait Client: RestClient {
    /// Send a REST query.
    fn rest(&self, request: Request<Vec<u8>>) -> Result<Response<Bytes>, APIError<Self::Error>>;
}

/// A trait representing an asynchronous client.
pub trait AsyncClient: RestClient {
    #[cfg(not(target_arch = "wasm32"))]
    /// Send a REST query asynchronously.
    fn rest_async(
        &self,
        request: Request<Vec<u8>>,
    ) -> impl Future<Output = Result<Response<Bytes>, APIError<Self::Error>>> + Send;

    #[cfg(target_arch = "wasm32")]
    /// Send a REST query asynchronously.
    fn rest_async(
        &self,
        request: Request<Vec<u8>>,
    ) -> impl Future<Output = Result<Response<Bytes>, APIError<Self::Error>>>;
}