anterofit 0.2.0

Wrap REST APIs with Rust traits using 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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! Types concerning the responses from REST calls.

pub use hyper::client::Response;

use std::io::{self, Read};

use serialize::{Deserialize, Deserializer};

use ::Result;

/// A trait describing types which can be converted from raw response bodies.
///
/// Implemented for `T: Deserialize + Send + 'static`.
///
/// Use `response::Raw` if you just want the response body, or `WithRaw` or `TryWithRaw`
/// if you want the response body and the deserialized value.
pub trait FromResponse: Send + Sized + 'static {
    /// Deserialize or otherwise convert an instance of `Self` from `response`.
    fn from_response<D>(des: &D, response: Response) -> Result<Self>
        where D: Deserializer;
}

impl<T> FromResponse for T where T: Deserialize + Send + 'static {
    fn from_response<D>(des: &D, mut response: Response) -> Result<Self>
        where D: Deserializer {
        des.deserialize(&mut response)
    }
}

/// Wrapper for `hyper::client::Response`.
///
/// Use this as a service method return type when you want to just get the raw response body from
/// a REST call.
///
/// Implements `Read` and `Into<hyper::client::Response>`.
pub struct Raw(pub Response);

impl Into<Response> for Raw {
    fn into(self) -> Response {
        self.0
    }
}

impl Read for Raw {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        self.0.read(buf)
    }
}

impl FromResponse for Raw {
    /// Simple wrapping operation; infallible.
    fn from_response<D>(_des: &D, response: Response) -> Result<Self>
        where D: Deserializer {

        Ok(Raw(response))
    }
}

/// Wrapper for the parsed response value along with the raw response.
///
/// Use this as a service method return type when you want to inspect the response
/// after the true return value has been deserialized.
pub struct WithRaw<T> {
    /// The raw `hyper::client::Response` instance.
    ///
    /// ### Note
    /// The deserializer will likely have already read to the end of the HTTP stream. Use `Raw`
    /// if you want to read the response yourself.
    pub raw: Response,
    /// The deserialized value.
    pub value: T,
}

impl<T> FromResponse for WithRaw<T> where T: Deserialize + Send + 'static {
    fn from_response<D>(des: &D, mut response: Response) -> Result<Self>
        where D: Deserializer {
        let val = try!(des.deserialize(&mut response));
        Ok(WithRaw {
            raw: response,
            value: val
        })
    }
}

/// Wrapper for the deserialization result along with the raw response.
///
/// Use this as a service method return type if you want the raw response whether
/// or not deserialization of the true return type succeeded.
pub struct TryWithRaw<T> {
    /// The raw `hyper::client::Response` instance.
    ///
    /// ### Note
    /// The deserializer will likely have already read to the end of the HTTP stream. Use `Raw`
    /// if you want to read the response yourself.
    pub raw: Response,
    /// The result of attempting to deserialize the value.
    pub result: Result<T>,
}

impl<T> FromResponse for TryWithRaw<T> where T: Deserialize + Send + 'static {
    fn from_response<D>(des: &D, mut response: Response) -> Result<Self>
        where D: Deserializer {
        let res = des.deserialize(&mut response);
        Ok(TryWithRaw {
            raw: response,
            result: res,
        })
    }
}

impl<T> Into<Result<T>> for TryWithRaw<T> {
    fn into(self) -> Result<T> {
        self.result
    }
}