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

#![allow(unused_parens, clippy::new_without_default)]
#![forbid(unsafe_code)]

//! Streaming responses support for reqwest for different formats:
//! - JSON array stream format
//! - JSON Lines (NL/NewLines) format
//! - CSV stream format
//! - Protobuf len-prefixed stream format
//!
//! This type of responses are useful when you are reading huge stream of objects from some source (such as database, file, etc)
//! and want to avoid huge memory allocations to store on the server side.
//!
//! # Example
//!
//! ```rust,no_run
//! use reqwest_streams::*;
//! use futures_util::stream::BoxStream;
//! use serde::{Deserialize, Serialize};
//!
//! #[derive(Debug, Clone, Deserialize)]
//! struct MyTestStructure {
//!     some_test_field: String
//! }
//!
//!#[tokio::main]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!
//!     let _stream = reqwest::get("http://localhost:8080/json-array")
//!         .await?
//!         .json_array_stream::<MyTestStructure>(1024);
//!
//!     Ok(())
//! }
//! ```
//! More and complete examples available on the github in the examples directory.
//!
//! ## Need server support?
//! There is the same functionality:
//! - [axum-streams](https://github.com/abdolence/axum-streams-rs).
//!

#[cfg(feature = "json")]
mod json_stream;
#[cfg(feature = "json")]
pub use json_stream::JsonStreamResponse;
#[cfg(feature = "json")]
mod json_array_codec;

#[cfg(feature = "csv")]
mod csv_stream;
#[cfg(feature = "csv")]
pub use csv_stream::CsvStreamResponse;

use crate::error::StreamBodyError;

#[cfg(feature = "protobuf")]
mod protobuf_stream;
#[cfg(feature = "protobuf")]
pub use protobuf_stream::ProtobufStreamResponse;
#[cfg(feature = "protobuf")]
mod protobuf_len_codec;

pub mod error;

pub type StreamBodyResult<T> = std::result::Result<T, StreamBodyError>;

#[cfg(test)]
mod test_client;