Struct tonic::server::Grpc

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

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,
    T::Encode: Sync, 

pub fn new(codec: T) -> Self

Creates a new gRPC server with the provided Codec.

pub fn accept_gzip(self) -> Self

This is supported on crate feature compression only.

Enable accepting gzip 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_gzip();

pub fn send_gzip(self) -> Self

This is supported on crate feature compression only.

Enable sending gzip 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_gzip();

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 + Sync + '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 + Sync + 'static,
    B: Body + Send + Sync + '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 + Sync + '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 + Sync + 'static,
    B: Body + Send + Sync + '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.