pretend 0.4.0

pretend is a modular, Feign-inspired, HTTP client based on macros.
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

//! Request interceptors
//!
//! `pretend` support request interceptors. They are used
//! to post-process an automatically generated request before
//! it is being executed.
//!
//! Interceptors can facilitate setting common headers, like
//! an user-agent, or injecting an authentication token.
//!
//! By default a [`NoopRequestInterceptor`] is used, and will
//! not modify the request.
//!
//! Custom interceptors are defined by implementing [`InterceptRequest`].
//!
//! # Error handling
//!
//! Request interceptors are allowed to fail. They return a pretend
//! `Result` that will be returned as is to the caller. Prefer using
//! `Error::Request` when reporting an error.

pub use crate::client::Method;
pub use crate::{HeaderMap, Result, Url};

/// An HTTP request
#[non_exhaustive]
pub struct Request {
    /// Request method
    pub method: Method,
    /// Full request URL
    pub url: Url,
    /// Request headers
    pub headers: HeaderMap,
}

impl Request {
    /// Constructor
    ///
    /// This constructor can be used
    /// to construct customized requests
    /// inside a request interceptor.
    pub fn new(method: Method, url: Url, headers: HeaderMap) -> Self {
        Request {
            method,
            url,
            headers,
        }
    }
}

/// Describe a request interceptor
///
/// See module level documentation for more information.
pub trait InterceptRequest {
    /// Intercept a request, returning a customized request
    fn intercept(&self, request: Request) -> Result<Request>;
}

/// Default request interceptor
///
/// This request interceptor will not modify
/// the request.
#[derive(Clone, Copy, Debug, Default)]
pub struct NoopRequestInterceptor;

impl InterceptRequest for NoopRequestInterceptor {
    fn intercept(&self, request: Request) -> Result<Request> {
        Ok(request)
    }
}