Struct tonic::Request

pub struct Request<T> { /* fields omitted */ }

A gRPC request and metadata from an RPC call.

Implementations

impl<T> Request<T>

pub fn new(message: T) -> Self

Create a new gRPC request.

Request::new(HelloRequest {
   name: "Bob".into(),
});

pub fn get_ref(&self) -> &T

Get a reference to the message

pub fn get_mut(&mut self) -> &mut T

Get a mutable reference to the message

pub fn metadata(&self) -> &MetadataMap

Get a reference to the custom request metadata.

pub fn metadata_mut(&mut self) -> &mut MetadataMap

Get a mutable reference to the request metadata.

pub fn into_inner(self) -> T

Consumes self, returning the message

pub fn from_http(http: Request<T>) -> Self

Convert an HTTP request to a gRPC request

pub fn remote_addr(&self) -> Option<SocketAddr>

Get the remote address of this connection.

This will return None if the IO type used does not implement Connected. This currently, only works on the server side.

pub fn peer_certs(&self) -> Option<Arc<Vec<Certificate>>>

This is supported on crate feature transport only.

Get the peer certificates of the connected client.

This is used to fetch the certificates from the TLS session and is mostly used for mTLS. This currently only returns Some on the server side of the transport server with TLS enabled connections.

pub fn set_timeout(&mut self, deadline: Duration)

Set the max duration the request is allowed to take.

Requires the server to support the grpc-timeout metadata, which Tonic does.

The duration will be formatted according to the spec and use the most precise unit possible.

Example:

use std::time::Duration;
use tonic::Request;

let mut request = Request::new(());

request.set_timeout(Duration::from_secs(30));

let value = request.metadata().get("grpc-timeout").unwrap();

assert_eq!(
    value,
    // equivalent to 30 seconds
    "30000000u"
);

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

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

Returns a mutable reference to the associated extensions.

Example

Extensions can be set in interceptors:

use tonic::{Request, service::interceptor_fn};

struct MyExtension {
    some_piece_of_data: String,
}

interceptor_fn(|mut request: Request<()>| {
    request.extensions_mut().insert(MyExtension {
        some_piece_of_data: "foo".to_string(),
    });

    Ok(request)
});

And picked up by RPCs:

use tonic::{async_trait, Status, Request, Response};

#[async_trait]
impl TestService for MyService {
    async fn handler(&self, req: Request<Input>) -> Result<Response<Output>, Status> {
        let value: &MyExtension = req.extensions().get::<MyExtension>().unwrap();

        Ok(Response::new(Output {}))
    }
}

Trait Implementations

impl<T: Debug> Debug for Request<T>

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

Formats the value using the given formatter.

impl<T> IntoRequest<T> for Request<T>

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<T> IntoStreamingRequest for Request<T> where
    T: Stream + Send + Sync + 'static, 

type Stream = T

The RPC request stream type

type Message = T::Item

The RPC request type

fn into_streaming_request(self) -> Self

Wrap the stream of messages in a tonic::Request