Struct tonic::server::Grpc

pub struct Grpc<T> { /* private fields */ }

A gRPC Server handler.

This will wrap some inner Codec and provide utilities to handle inbound unary, client side streaming, server side streaming, and bi-directional streaming.

Each request handler method accepts some service that implements the corresponding service trait and a http request that contains some body that implements some Body.

Implementations

impl<T> Grpc<T>where
    T: Codec,

pub fn new(codec: T) -> Self

Creates a new gRPC server with the provided Codec.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable accepting compressed requests.

If a request with an unsupported encoding is received the server will respond with Code::UnUnimplemented.

Example

The most common way of using this is through a server generated by tonic-build:

#[tonic::async_trait]
impl Example for Svc {
    // ...
}

let service = ExampleServer::new(Svc).accept_compressed(CompressionEncoding::Gzip);

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Enable sending compressed responses.

Requires the client to also support receiving compressed responses.

Example

The most common way of using this is through a server generated by tonic-build:

#[tonic::async_trait]
impl Example for Svc {
    // ...
}

let service = ExampleServer::new(Svc).send_compressed(CompressionEncoding::Gzip);

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Example

The most common way of using this is through a server generated by tonic-build:

#[tonic::async_trait]
impl Example for Svc {
    // ...
}

// Set the limit to 2MB, Defaults to 4MB.
let limit = 2 * 1024 * 1024;
let service = ExampleServer::new(Svc).max_decoding_message_size(limit);

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a encoded message.

Example

The most common way of using this is through a server generated by tonic-build:

#[tonic::async_trait]
impl Example for Svc {
    // ...
}

// Set the limit to 2MB, Defaults to 4MB.
let limit = 2 * 1024 * 1024;
let service = ExampleServer::new(Svc).max_encoding_message_size(limit);

pub async fn unary<S, B>(
    &mut self,
    service: S,
    req: Request<B>
) -> Response<BoxBody>where
    S: UnaryService<T::Decode, Response = T::Encode>,
    B: Body + Send + 'static,
    B::Error: Into<Box<dyn Error + Send + Sync>> + Send,

Handle a single unary gRPC request.

pub async fn server_streaming<S, B>(
    &mut self,
    service: S,
    req: Request<B>
) -> Response<BoxBody>where
    S: ServerStreamingService<T::Decode, Response = T::Encode>,
    S::ResponseStream: Send + 'static,
    B: Body + Send + 'static,
    B::Error: Into<Box<dyn Error + Send + Sync>> + Send,

Handle a server side streaming request.

pub async fn client_streaming<S, B>(
    &mut self,
    service: S,
    req: Request<B>
) -> Response<BoxBody>where
    S: ClientStreamingService<T::Decode, Response = T::Encode>,
    B: Body + Send + 'static,
    B::Error: Into<Box<dyn Error + Send + Sync>> + Send + 'static,

Handle a client side streaming gRPC request.

pub async fn streaming<S, B>(
    &mut self,
    service: S,
    req: Request<B>
) -> Response<BoxBody>where
    S: StreamingService<T::Decode, Response = T::Encode> + Send,
    S::ResponseStream: Send + 'static,
    B: Body + Send + 'static,
    B::Error: Into<Box<dyn Error + Send + Sync>> + Send,

Handle a bi-directional streaming gRPC request.

Trait Implementations

impl<T: Debug> Debug for Grpc<T>

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

Formats the value using the given formatter.