Struct Request

pub struct Request { /* private fields */ }

Request objects are what a FastCGI application will primarily deal with throughout its lifetime.

The Request API is designed to be an abstraction of the traditional CGI process model. Note that this API is low level. Dealing with things like GET/POST parameters or cookies is outside the scope of this library.

Implementations

impl Request

pub fn role(&self) -> Role

pub fn param(&self, key: &str) -> Option<String>

Retrieves the value of the given parameter name.

pub fn params(&self) -> Params<'_>

Iterates over the FastCGI parameters.

pub fn stdin(&mut self) -> Stdin<'_>

Standard input stream of the request.

pub fn stdout(&mut self) -> Stdout<'_>

Standard output stream of the request.

Examples found in repository

examples/hello.rs (line 7)

fn main() {
    fastcgi::run(|mut req| {
        write!(&mut req.stdout(), "Content-Type: text/plain\n\nHello, world!")
        .unwrap_or(());
    });
}

pub fn stderr(&mut self) -> Stderr<'_>

Standard error stream of the request.

pub fn is_aborted(&self) -> bool

Checks if the client has closed the connection prematurely.

The reliability of this method depends on whether the web server notifies such event (by sending the FCGI_REQUEST_ABORTED record) to the FastCGI application. This value is updated synchronously; the update may only be triggered by reading from stdin.

pub fn exit(self, code: i32)

Reports the specified exit code to the web server.

This will consume the Request object. If you finish processing the Request object without calling exit, it is assumed that the exit code is 0.

Trait Implementations

impl Drop for Request

fn drop(&mut self)

Executes the destructor for this type.