fastcgi-client 0.4.0

Fastcgi client implemented for Rust.
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

//! Fastcgi client implemented for Rust.
//!
//! ![fastcgi-client-rs](https://raw.githubusercontent.com/jmjoy/fastcgi-client-rs/master/fastcgi-client-rs.png)
//!
//! ## Features
//!
//! Support both `async(async-std)` and `sync(std)` clients.
//!
//! Be default, both `async` and `sync` client are included, if you don't want to include `async` client,
//! You can specify `default-features = false` in `Cargo.toml`.
//!
//! ## Installation
//!
//! With [cargo add](https://github.com/killercup/cargo-edit) installed run:
//!
//! ```bash
//! $ cargo add fastcgi-client
//! ```
//!
//! ## Examples
//!
//! Async `async-std` client:
//!
//! ```
//! use fastcgi_client::{AsyncClient, Params};
//! use std::env;
//! use async_std::{io, task};
//! use async_std::net::TcpStream;
//!
//! task::block_on(async {
//!     let script_filename = env::current_dir()
//!         .unwrap()
//!         .join("tests")
//!         .join("php")
//!         .join("index.php");
//!     let script_filename = script_filename.to_str().unwrap();
//!     let script_name = "/index.php";
//!
//!     // Connect to php-fpm default listening address.
//!     let stream = TcpStream::connect(("127.0.0.1", 9000)).await.unwrap();
//!     let mut client = AsyncClient::new(stream, false);
//!
//!     // Fastcgi params, please reference to nginx-php-fpm config.
//!     let params = Params::with_predefine()
//!         .set_request_method("GET")
//!         .set_script_name(script_name)
//!         .set_script_filename(script_filename)
//!         .set_request_uri(script_name)
//!         .set_document_uri(script_name)
//!         .set_remote_addr("127.0.0.1")
//!         .set_remote_port("12345")
//!         .set_server_addr("127.0.0.1")
//!         .set_server_port("80")
//!         .set_server_name("jmjoy-pc")
//!         .set_content_type("")
//!         .set_content_length("0");
//!
//!     // Fetch fastcgi server(php-fpm) response.
//!     let output = client.do_request(&params, &mut io::empty()).await.unwrap();
//!
//!     // "Content-type: text/html; charset=UTF-8\r\n\r\nhello"
//!     let stdout = String::from_utf8(output.get_stdout().unwrap()).unwrap();
//!
//!     assert!(stdout.contains("Content-type: text/html; charset=UTF-8"));
//!     assert!(stdout.contains("hello"));
//!     assert_eq!(output.get_stderr(), None);
//! });
//! ```
//!
//! Sync `std` client:
//!
//! ```
//! use fastcgi_client::{Client, Params};
//! use std::{env, io};
//! use std::net::TcpStream;
//!
//! let script_filename = env::current_dir()
//!     .unwrap()
//!     .join("tests")
//!     .join("php")
//!     .join("index.php");
//! let script_filename = script_filename.to_str().unwrap();
//! let script_name = "/index.php";
//!
//! // Connect to php-fpm default listening address.
//! let stream = TcpStream::connect(("127.0.0.1", 9000)).unwrap();
//! let mut client = Client::new(stream, false);
//!
//! // Fastcgi params, please reference to nginx-php-fpm config.
//! let params = Params::with_predefine()
//!     .set_request_method("GET")
//!     .set_script_name(script_name)
//!     .set_script_filename(script_filename)
//!     .set_request_uri(script_name)
//!     .set_document_uri(script_name)
//!     .set_remote_addr("127.0.0.1")
//!     .set_remote_port("12345")
//!     .set_server_addr("127.0.0.1")
//!     .set_server_port("80")
//!     .set_server_name("jmjoy-pc")
//!     .set_content_type("")
//!     .set_content_length("0");
//!
//! // Fetch fastcgi server(php-fpm) response.
//! let output = client.do_request(&params, &mut io::empty()).unwrap();
//!
//! // "Content-type: text/html; charset=UTF-8\r\n\r\nhello"
//! let stdout = String::from_utf8(output.get_stdout().unwrap()).unwrap();
//!
//! assert!(stdout.contains("Content-type: text/html; charset=UTF-8"));
//! assert!(stdout.contains("hello"));
//! assert_eq!(output.get_stderr(), None);
//! ```
//!
//! ## License
//! [MIT](https://github.com/jmjoy/fastcgi-client-rs/blob/master/LICENSE).
//!

mod client;
mod error;
mod id;
mod meta;
mod params;

pub use crate::client::Client;
pub use crate::error::*;
pub use crate::meta::Output;
pub use crate::params::Params;

#[cfg(feature = "async_std")]
pub use crate::client::AsyncClient;

/// Version of this crate.
pub const VERSION: &'static str = env!("LIB_BUILD_VERSION");