Struct FastCgiClientRequest 

pub struct FastCgiClientRequest {
    pub params: Vec<(Bytes, Bytes)>,
    pub stdin: FastCgiBody,
    pub extensions: Extensions,
}

Available on crate feature fastcgi only.

A FastCGI client request to send to a backend application server.

Construct one with the CGI environment variables (params) and optionally a request body (stdin), then serve it via FastCgiClient.

stdin is a streaming FastCgiBody; any of Bytes, Vec<u8>, String, &'static [u8], or an [AsyncRead][tokio::io::AsyncRead] wrapper can be passed via Self::with_stdin.

Fields

params: Vec<(Bytes, Bytes)>

CGI environment variables to send as FCGI_PARAMS.

stdin: FastCgiBody

Request body to send as FCGI_STDIN (may be empty for GET requests).

extensions: Extensions

Extensions for routing and metadata (e.g. connector target address).

Implementations

impl FastCgiClientRequest

pub fn new(params: impl Into<Vec<(Bytes, Bytes)>>) -> FastCgiClientRequest

Create a new FastCgiClientRequest with the given params and an empty stdin.

pub fn with_stdin(self, stdin: impl Into<FastCgiBody>) -> FastCgiClientRequest

Attach a request body (stdin).

Accepts anything convertible into a FastCgiBody: Bytes, Vec<u8>, String, &'static [u8], or wrap a streaming reader with FastCgiBody::from_reader.

pub fn push_param( &mut self, name: impl Into<Bytes>, value: impl Into<Bytes>, ) -> &mut FastCgiClientRequest

Append a single CGI name-value pair to Self::params.

Pair the name with the constants in proto::cgi to avoid bare-string literals at call sites:

use rama_fastcgi::{FastCgiClientRequest, proto::cgi};

let mut req = FastCgiClientRequest::new(vec![]);
req.push_param(cgi::SCRIPT_FILENAME, "/var/www/index.php");
req.push_param(cgi::DOCUMENT_ROOT,   "/var/www");

Both arguments accept anything that converts into Bytes — &'static [u8], &'static str, Bytes, Vec<u8>, String, etc.

pub fn with_param( self, name: impl Into<Bytes>, value: impl Into<Bytes>, ) -> FastCgiClientRequest

Builder-style sibling of Self::push_param: append a pair and return self for chaining.

pub fn extensions_mut(&mut self) -> &mut Extensions

Get a mutable reference to the extensions.

Trait Implementations

impl Debug for FastCgiClientRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl ExtensionsRef for FastCgiClientRequest

fn extensions(&self) -> &Extensions

Get reference to the underlying Extensions store

impl<S, IO> Service<FastCgiClientRequest> for FastCgiClient<S>

where S: Service<FastCgiClientRequest, Output = EstablishedClientConnection<IO, FastCgiClientRequest>>, <S as Service<FastCgiClientRequest>>::Error: Into<Box<dyn Error + Send + Sync>>, IO: AsyncRead + AsyncWrite + Unpin + Send + 'static,

type Output = FastCgiClientResponse

The type of the output returned by the service.

type Error = Box<dyn Error + Send + Sync>

The type of error returned by the service.

async fn serve( &self, req: FastCgiClientRequest, ) -> Result<<FastCgiClient<S> as Service<FastCgiClientRequest>>::Output, <FastCgiClient<S> as Service<FastCgiClientRequest>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

impl Service<FastCgiClientRequest> for FastCgiTcpConnector

type Output = EstablishedClientConnection<TcpStream, FastCgiClientRequest>

The type of the output returned by the service.

type Error = Box<dyn Error + Send + Sync>

The type of error returned by the service.

async fn serve( &self, input: FastCgiClientRequest, ) -> Result<<FastCgiTcpConnector as Service<FastCgiClientRequest>>::Output, <FastCgiTcpConnector as Service<FastCgiClientRequest>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

impl Service<FastCgiClientRequest> for FastCgiUnixConnector

type Output = EstablishedClientConnection<UnixStream, FastCgiClientRequest>

The type of the output returned by the service.

type Error = Box<dyn Error + Send + Sync>

The type of error returned by the service.

async fn serve( &self, input: FastCgiClientRequest, ) -> Result<<FastCgiUnixConnector as Service<FastCgiClientRequest>>::Output, <FastCgiUnixConnector as Service<FastCgiClientRequest>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.