//! curl-http-client: This is a wrapper for [Easy2](https://docs.rs/curl/latest/curl/easy/struct.Easy2.html) from [curl-rust](https://docs.rs/curl/latest/curl) crate for ergonomic use
//! and is able to perform synchronously and asynchronously using [async-curl](https://docs.rs/async-curl/latest/async_curl) crate that uses an actor model
//! (Message passing) to achieve a non-blocking I/O.
//! This requires a dependency with the [curl](https://crates.io/crates/curl), [async-curl](https://crates.io/crates/async-curl)
//! [http](https://crates.io/crates/http), [url](https://crates.io/crates/url) and [tokio](https://crates.io/crates/tokio) crates
//!
//! # Asynchronous Examples
//! ## Get Request
//! ```rust,no_run
//! use async_curl::actor::CurlActor;
//! use curl_http_client::{collector::Collector, http_client::HttpClient, request::HttpRequest};
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//!     let actor = CurlActor::new();
//!     let collector = Collector::Ram(Vec::new());
//!
//!     let request = HttpRequest {
//!         url: Url::parse("<SOURCE URL>").unwrap(),
//!         method: Method::GET,
//!         headers: HeaderMap::new(),
//!         body: None,
//!     };
//!
//!     let response = HttpClient::new(collector)
//!         .request(request).unwrap()
//!         .nonblocking(actor)
//!         .perform()
//!         .await.unwrap();
//!
//!     println!("Response: {:?}", response);
//! }
//! ```
//!
//! ## Post Request
//! ```rust,no_run
//! use async_curl::actor::CurlActor;
//! use curl_http_client::{collector::Collector, http_client::HttpClient, request::HttpRequest};
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//!     let actor = CurlActor::new();
//!     let collector = Collector::Ram(Vec::new());
//!
//!     let request = HttpRequest {
//!         url: Url::parse("<TARGET URL>").unwrap(),
//!         method: Method::POST,
//!         headers: HeaderMap::new(),
//!         body: Some("test body".as_bytes().to_vec()),
//!     };
//!
//!     let response = HttpClient::new(collector)
//!         .request(request).unwrap()
//!         .nonblocking(actor)
//!         .perform()
//!         .await.unwrap();
//!
//!     println!("Response: {:?}", response);
//! }
//! ```
//!
//! ## Downloading a File
//! ```rust,no_run
//! use std::path::PathBuf;
//!
//! use async_curl::actor::CurlActor;
//! use curl_http_client::{
//!     collector::{Collector, FileInfo},
//!     http_client::HttpClient,
//!     request::HttpRequest,
//! };
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     let actor = CurlActor::new();
//!
//!     let collector = Collector::File(FileInfo::path(PathBuf::from("<FILE PATH TO SAVE>")));
//!
//!     let request = HttpRequest {
//!         url: Url::parse("<SOURCE URL>").unwrap(),
//!         method: Method::GET,
//!         headers: HeaderMap::new(),
//!         body: None,
//!     };
//!
//!     let response = HttpClient::new(collector)
//!         .request(request)
//!         .unwrap()
//!         .nonblocking(actor)
//!         .perform()
//!         .await.unwrap();
//!
//!     println!("Response: {:?}", response);
//!     Ok(())
//! }
//! ```
//!
//! ## Uploading a File
//! ```rust,no_run
//! use std::{fs, path::PathBuf};
//!
//! use async_curl::actor::CurlActor;
//! use curl_http_client::{
//!     collector::{Collector, FileInfo},
//!     http_client::{FileSize, HttpClient},
//!     request::HttpRequest,
//! };
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//!     let file_to_be_uploaded = PathBuf::from("<FILE PATH TO BE UPLOADED>");
//!     let file_size = fs::metadata(file_to_be_uploaded.as_path()).unwrap().len() as usize;
//!
//!     let actor = CurlActor::new();
//!     let collector = Collector::File(FileInfo::path(file_to_be_uploaded));
//!
//!     let request = HttpRequest {
//!         url: Url::parse("<TARGET URL>").unwrap(),
//!         method: Method::PUT,
//!         headers: HeaderMap::new(),
//!         body: None,
//!     };
//!
//!     let response = HttpClient::new(collector)
//!         .upload_file_size(FileSize::from(file_size)).unwrap()
//!         .request(request).unwrap()
//!         .nonblocking(actor)
//!         .perform()
//!         .await.unwrap();
//!
//!     println!("Response: {:?}", response);
//! }
//! ```
//!
//! ## Concurrency
//! ```rust,no_run
//! use async_curl::actor::CurlActor;
//! use curl_http_client::{collector::Collector, http_client::HttpClient, request::HttpRequest};
//! use futures::future;
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//!     const NUM_CONCURRENT: usize = 5;
//!
//!     let actor = CurlActor::new();
//!     let mut handles = Vec::new();
//!
//!     for _n in 0..NUM_CONCURRENT {
//!         let actor = actor.clone();
//!
//!         let handle = tokio::spawn(async move {
//!             let collector = Collector::Ram(Vec::new());
//!             let request = HttpRequest {
//!                 url: Url::parse("https://www.rust-lang.org/").unwrap(),
//!                 method: Method::GET,
//!                 headers: HeaderMap::new(),
//!                 body: None,
//!             };
//!
//!             let response = HttpClient::new(collector)
//!                 .request(request)
//!                 .unwrap()
//!                 .nonblocking(actor)
//!                 .perform()
//!                 .await
//!                 .unwrap();
//!             println!("Response: {:?}", response);
//!         });
//!         handles.push(handle);
//!     }
//!
//!     let results: Vec<Result<_, _>> = future::join_all(handles).await;
//!
//!     for (_i, result) in results.into_iter().enumerate() {
//!         result.unwrap();
//!     }
//! }
//! ```
//!
//! ## Resume Downloading a File
//! ```rust,no_run
//! use std::fs;
//! use std::path::PathBuf;
//!
//! use async_curl::actor::CurlActor;
//! use curl_http_client::{
//!     collector::{Collector, FileInfo},
//!     http_client::{BytesOffset, HttpClient},
//!     request::HttpRequest,
//! };
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//!     let actor = CurlActor::new();
//!     let save_to = PathBuf::from("<FILE PATH TO SAVE>");
//!     let collector = Collector::File(FileInfo::path(save_to.clone()));
//!
//!     let partial_download_file_size = fs::metadata(save_to.as_path()).unwrap().len() as usize;
//!     let request = HttpRequest {
//!         url: Url::parse("<SOURCE URL>").unwrap(),
//!         method: Method::GET,
//!         headers: HeaderMap::new(),
//!         body: None,
//!     };
//!
//!     let response = HttpClient::new(collector)
//!         .resume_from(BytesOffset::from(partial_download_file_size)).unwrap()
//!         .request(request).unwrap()
//!         .nonblocking(actor)
//!         .perform()
//!         .await.unwrap();
//!
//!     println!("Response: {:?}", response);
//! }
//! ```
//!
//! ## Downloading a File with download speed information sent to different task
//! ```rust,no_run
//! use std::path::PathBuf;
//!
//! use async_curl::actor::CurlActor;
//! use curl_http_client::{
//!     collector::{Collector, FileInfo},
//!     http_client::HttpClient,
//!     request::HttpRequest,
//! };
//! use http::{HeaderMap, Method};
//! use tokio::sync::mpsc::channel;
//! use url::Url;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//!     let (tx, mut rx) = channel(1);
//!
//!     let actor = CurlActor::new();
//!     let file_info = FileInfo::path(PathBuf::from("<FILE PATH TO SAVE>")).with_transfer_speed_sender(tx);
//!     let collector = Collector::File(file_info);
//!
//!     let handle = tokio::spawn(async move {
//!         while let Some(speed) = rx.recv().await {
//!             println!("Download Speed: {} kB/s", speed.as_bytes_per_sec());
//!         }
//!     });
//!
//!     let request = HttpRequest {
//!         url: Url::parse("<SOURCE URL>").unwrap(),
//!         method: Method::GET,
//!         headers: HeaderMap::new(),
//!         body: None,
//!     };
//!
//!     let response = HttpClient::new(collector)
//!         .request(request).unwrap()
//!         .nonblocking(actor)
//!         .perform()
//!         .await.unwrap();
//!
//!     println!("Response: {:?}", response);
//!
//!     handle.abort();
//! }
//! ```
//!
//! ## Uploading a File with upload speed information sent to different task
//! ```rust,no_run
//! use std::{fs, path::PathBuf};
//!
//! use async_curl::actor::CurlActor;
//! use curl_http_client::{
//!     collector::{Collector, FileInfo},
//!     http_client::{FileSize, HttpClient},
//!     request::HttpRequest,
//! };
//! use http::{HeaderMap, Method};
//! use tokio::sync::mpsc::channel;
//! use url::Url;
//!
//! #[tokio::main(flavor = "current_thread")]
//! async fn main() {
//!     let (tx, mut rx) = channel(1);
//!
//!     let file_to_be_uploaded = PathBuf::from("<FILE PATH TO BE UPLOADED>");
//!     let file_size = fs::metadata(file_to_be_uploaded.as_path()).unwrap().len() as usize;
//!
//!     let actor = CurlActor::new();
//!     let file_info = FileInfo::path(file_to_be_uploaded).with_transfer_speed_sender(tx);
//!     let collector = Collector::File(file_info);
//!
//!     let handle = tokio::spawn(async move {
//!         while let Some(speed) = rx.recv().await {
//!             println!("Upload Speed: {} kB/s", speed.as_bytes_per_sec());
//!         }
//!     });
//!
//!     let request = HttpRequest {
//!         url: Url::parse("<TARGET URL>").unwrap(),
//!         method: Method::PUT,
//!         headers: HeaderMap::new(),
//!         body: None,
//!     };
//!
//!     let response = HttpClient::new(collector)
//!         .upload_file_size(FileSize::from(file_size)).unwrap()
//!         .request(request).unwrap()
//!         .nonblocking(actor)
//!         .perform()
//!         .await.unwrap();
//!
//!     println!("Response: {:?}", response);
//!     handle.abort();
//! }
//! ```
//!
//! # Synchronous Examples
//! ## Get Request
//! ```rust,no_run
//! use curl_http_client::{collector::Collector, http_client::HttpClient, request::HttpRequest};
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! let collector = Collector::Ram(Vec::new());
//!
//! let request = HttpRequest {
//!     url: Url::parse("<SOURCE URL>").unwrap(),
//!     method: Method::GET,
//!     headers: HeaderMap::new(),
//!     body: None,
//! };
//!
//! let response = HttpClient::new(collector)
//!     .request(request).unwrap()
//!     .blocking()
//!     .perform()
//!     .unwrap();
//!
//! println!("Response: {:?}", response);
//! ```
//!
//! ## Post Request
//! ```rust,no_run
//! use curl_http_client::{collector::Collector, http_client::HttpClient, request::HttpRequest};
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! let collector = Collector::Ram(Vec::new());
//!
//! let request = HttpRequest {
//!     url: Url::parse("<TARGET URL>").unwrap(),
//!     method: Method::POST,
//!     headers: HeaderMap::new(),
//!     body: Some("test body".as_bytes().to_vec()),
//! };
//!
//! let response = HttpClient::new(collector)
//!     .request(request).unwrap()
//!     .blocking()
//!     .perform()
//!     .unwrap();
//!
//! println!("Response: {:?}", response);
//! ```
//!
//! ## Downloading a File
//! ```rust,no_run
//! use std::path::PathBuf;
//!
//! use curl_http_client::{
//!     collector::{Collector, FileInfo},
//!     http_client::HttpClient,
//!     request::HttpRequest,
//! };
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! let collector = Collector::File(FileInfo::path(PathBuf::from("<FILE PATH TO SAVE>")));
//!
//! let request = HttpRequest {
//!     url: Url::parse("<SOURCE URL>").unwrap(),
//!     method: Method::GET,
//!     headers: HeaderMap::new(),
//!     body: None,
//! };
//!
//! let response = HttpClient::new(collector)
//!     .request(request)
//!     .unwrap()
//!     .blocking()
//!     .perform()
//!     .unwrap();
//!
//! println!("Response: {:?}", response);
//! ```
//!
//! ## Uploading a File
//! ```rust,no_run
//! use std::{fs, path::PathBuf};
//!
//! use curl_http_client::{
//!     collector::{Collector, FileInfo},
//!     http_client::{FileSize, HttpClient},
//!     request::HttpRequest,
//! };
//! use http::{HeaderMap, Method};
//! use url::Url;
//!
//! let file_to_be_uploaded = PathBuf::from("<FILE PATH TO BE UPLOADED>");
//! let file_size = fs::metadata(file_to_be_uploaded.as_path()).unwrap().len() as usize;
//! let collector = Collector::File(FileInfo::path(file_to_be_uploaded));
//!
//! let request = HttpRequest {
//!     url: Url::parse("<TARGET URL>").unwrap(),
//!     method: Method::PUT,
//!     headers: HeaderMap::new(),
//!     body: None,
//! };
//!
//! let response = HttpClient::new(collector)
//!     .upload_file_size(FileSize::from(file_size)).unwrap()
//!     .request(request).unwrap()
//!     .blocking()
//!     .perform()
//!     .unwrap();
//!
//! println!("Response: {:?}", response);
//! ```
//!
pub mod collector;
pub mod error;
pub mod http_client;
pub mod request;
pub mod response;

pub mod dep {
    pub use curl;
}

#[cfg(test)]
mod test;