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
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
use std::error::Error;
use async_trait::async_trait;
use bytes::Bytes;
use http::request::Builder as RequestBuilder;
use http::Response;
use url::Url;
use crate::api::{ApiError, UrlBase};
/// A trait representing a client which can communicate with a GitLab instance via REST.
pub trait RestClient {
/// The errors which may occur for this client.
type Error: Error + Send + Sync + 'static;
/// Get the URL for a REST v4 endpoint for the client.
///
/// This method adds the hostname for the client's target instance.
fn rest_endpoint(&self, endpoint: &str) -> Result<Url, ApiError<Self::Error>>;
/// Get the URL for an instance endpoint for the client.
fn instance_endpoint(&self, endpoint: &str) -> Result<Url, ApiError<Self::Error>> {
let _ = endpoint;
Err(ApiError::unsupported_url_base(UrlBase::Instance))
}
}
/// A trait representing a client which can communicate with a GitLab instance.
pub trait Client: RestClient {
/// Send a REST query.
fn rest(
&self,
request: RequestBuilder,
body: Vec<u8>,
) -> Result<Response<Bytes>, ApiError<Self::Error>>;
}
/// A trait representing an asynchronous client which can communicate with a GitLab instance.
#[async_trait]
pub trait AsyncClient: RestClient {
/// Send a REST query asynchronously.
async fn rest_async(
&self,
request: RequestBuilder,
body: Vec<u8>,
) -> Result<Response<Bytes>, ApiError<Self::Error>>;
}