Struct tonic::server::Grpc

source ·
pub struct Grpc<T> { /* private fields */ }
Expand description

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§

source§

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

source

pub fn new(codec: T) -> Self

Creates a new gRPC server with the provided Codec.

source

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);
source

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);
source

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);
source

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);
source

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.

source

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.

source

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.

source

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§

source§

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

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Grpc<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Grpc<T>
where T: RefUnwindSafe,

§

impl<T> Send for Grpc<T>
where T: Send,

§

impl<T> Sync for Grpc<T>
where T: Sync,

§

impl<T> Unpin for Grpc<T>
where T: Unpin,

§

impl<T> UnwindSafe for Grpc<T>
where T: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more