Struct ReceivedRequest 

#[non_exhaustive]
pub struct ReceivedRequest { /* private fields */ }

The HTTP request a transcoded gRPC call was made from, as the proxy received it: its method, its path and query, and the gRPC path of the RPC the matched binding selected.

The path is the one on the request line, before a router the proxy is nested in strips its prefix, so an alias or a public prefix stays visible. An absolute-form target (any HTTP/2 request, an HTTP/1.1 request through a forward proxy) records its path and query alone, so one request records the same value over either protocol. No header the client sends (x-original-uri, forwarding headers) changes it.

Examples

use structured_proxy::ReceivedRequest;

// What a tonic handler behind the proxy does with it.
fn target(request: &tonic::Request<()>) -> Option<String> {
    let received = request.extensions().get::<ReceivedRequest>()?;
    Some(format!("{} {}", received.method(), received.path_and_query()))
}

let received = ReceivedRequest::new(
    http::Method::POST,
    http::uri::PathAndQuery::from_static("/v1/orgs/42:suspend?dry=1"),
    http::uri::PathAndQuery::from_static("/acme.v1.Orgs/Suspend"),
);
let mut request = tonic::Request::new(());
request.extensions_mut().insert(received);
assert_eq!(target(&request).as_deref(), Some("POST /v1/orgs/42:suspend?dry=1"));

Implementations

impl ReceivedRequest

pub fn new( method: Method, path_and_query: PathAndQuery, rpc: PathAndQuery, ) -> Self

A request received as method path_and_query, transcoded to the RPC at the gRPC path rpc. The view an upstream’s own tests hand it.

pub fn method(&self) -> &Method

The HTTP method as received: HEAD on a route bound to GET stays HEAD, and a custom binding’s method is itself.

pub fn path_and_query(&self) -> &PathAndQuery

The path and query as received, percent-encoding untouched.

pub fn rpc(&self) -> &str

The gRPC path of the RPC the matched binding selected (/package.Service/Method).

Trait Implementations

impl Clone for ReceivedRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReceivedRequest

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

Formats the value using the given formatter.

impl Eq for ReceivedRequest

impl PartialEq for ReceivedRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ReceivedRequest