rama-http 0.2.0

rama http layers, services and other utilities
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

use super::IntoResponse;
use crate::{Body, Response, dep::http::StatusCode};
use bytes::buf::Writer;
use bytes::{BufMut, BytesMut};
use csv;
use rama_core::error::OpaqueError;
use rama_http_headers::ContentType;
use rama_utils::macros::impl_deref;
use serde::Serialize;
use std::fmt;

use super::Headers;

/// Wrapper used to create Csv Http [`Response`]s,
/// as well as to extract Csv from Http [`Request`] bodies.
///
/// [`Request`]: crate::Request
/// [`Response`]: crate::Response
///
/// # Examples
///
/// ## Creating a Csv Response
///
/// ```
/// use serde_json::json;
/// use rama_http::service::web::response::{IntoResponse, Csv};
///
/// async fn handler() -> impl IntoResponse {
///     Csv(
///         vec![
///             json!({
///                 "name": "john",
///                 "age": 30,
///                 "is_student": false
///             })
///         ]
///     )
/// }
/// ```
///
/// ## Extracting Csv from a Request
///
/// ```
/// use serde_json::json;
/// use rama_http::service::web::response::Csv;
///
/// #[derive(Debug, serde::Deserialize)]
/// struct Input {
///     name: String,
///     age: u8,
///     alive: Option<bool>,
/// }
///
/// # fn bury(name: impl AsRef<str>) {}
///
/// async fn handler(Csv(input): Csv<Vec<Input>>) {
///     if !input[0].alive.unwrap_or_default() {
///         bury(&input[0].name);
///     }
/// }
/// ```
pub struct Csv<T>(pub T);

impl<T: fmt::Debug> fmt::Debug for Csv<T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("Csv").field(&self.0).finish()
    }
}

impl<T: Clone> Clone for Csv<T> {
    fn clone(&self) -> Self {
        Self(self.0.clone())
    }
}

impl_deref!(Csv);

impl<T> From<T> for Csv<T> {
    fn from(inner: T) -> Self {
        Self(inner)
    }
}

impl<T> IntoResponse for Csv<T>
where
    T: IntoIterator<Item: Serialize> + std::fmt::Debug,
{
    fn into_response(self) -> Response {
        // Extracted into separate fn so it's only compiled once for all T.
        fn make_respone(
            res: csv::Result<Vec<()>>,
            mut wtr: csv::Writer<Writer<BytesMut>>,
        ) -> Response {
            if let Err(err) = res {
                return (
                    StatusCode::INTERNAL_SERVER_ERROR,
                    Headers::single(ContentType::text_utf8()),
                    err.to_string(),
                )
                    .into_response();
            }
            if let Err(err) = wtr.flush() {
                return (
                    StatusCode::INTERNAL_SERVER_ERROR,
                    Headers::single(ContentType::text_utf8()),
                    err.to_string(),
                )
                    .into_response();
            }

            let bw = match wtr.into_inner() {
                Ok(bw) => bw,
                Err(err) => {
                    return (
                        StatusCode::INTERNAL_SERVER_ERROR,
                        Headers::single(ContentType::text_utf8()),
                        err.to_string(),
                    )
                        .into_response();
                }
            };

            (
                Headers::single(ContentType::csv_utf8()),
                bw.into_inner().freeze(),
            )
                .into_response()
        }

        // Use a small initial capacity of 128 bytes like serde_json::to_vec
        // https://docs.rs/serde_json/1.0.82/src/serde_json/ser.rs.html#2189
        let buf = BytesMut::with_capacity(128).writer();

        let mut wtr = csv::Writer::from_writer(buf);
        let res: Result<Vec<_>, _> = self.0.into_iter().map(|rec| wtr.serialize(rec)).collect();

        make_respone(res, wtr)
    }
}

impl<T> TryInto<Body> for Csv<T>
where
    T: IntoIterator<Item: Serialize>,
{
    type Error = OpaqueError;

    fn try_into(self) -> Result<Body, Self::Error> {
        // Use a small initial capacity of 128 bytes like serde_json::to_vec
        // https://docs.rs/serde_json/1.0.82/src/serde_json/ser.rs.html#2189
        let mut buf = BytesMut::with_capacity(128).writer();
        {
            let mut wtr = csv::Writer::from_writer(&mut buf);
            let res: Result<Vec<_>, _> = self.0.into_iter().map(|rec| wtr.serialize(rec)).collect();
            if let Err(err) = res {
                return Err(OpaqueError::from_std(err));
            }
            if let Err(err) = wtr.flush() {
                return Err(OpaqueError::from_std(err));
            }
        }

        Ok(buf.into_inner().freeze().into())
    }
}