Struct tonic::client::Grpc

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

A gRPC client dispatcher.

This will wrap some inner [GrpcService] and will encode/decode messages via the provided codec.

Each request method takes a [Request], a [PathAndQuery], and a [Codec]. The request contains the message to send via the [Codec::encoder]. The path determines the fully qualified path that will be append to the outgoing uri. The path must follow the conventions explained in the gRPC protocol definition under Path →. An example of this path could look like /greeter.Greeter/SayHello.

Methods

impl<T> Grpc<T>

pub fn new(inner: T) -> Self

Creates a new gRPC client with the provided [GrpcService].

pub fn with_interceptor(inner: T, interceptor: impl Into<Interceptor>) -> Self

Creates a new gRPC client with the provided [GrpcService] and will apply the provided interceptor on each request.

pub async fn ready<'_>(&'_ mut self) -> Result<(), T::Error> where
    T: GrpcService<BoxBody>, 

Check if the inner [GrpcService] is able to accept a new request.

This will call [GrpcService::poll_ready] until it returns ready or an error. If this returns ready the inner [GrpcService] is ready to accept one more request.

pub async fn unary<'_, M1, M2, C>(
    &'_ mut self,
    request: Request<M1>,
    path: PathAndQuery,
    codec: C
) -> Result<Response<M2>, Status> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    <T::ResponseBody as HttpBody>::Error: Into<Box<dyn Error + Send + Sync>>,
    C: Codec<Encode = M1, Decode = M2>,
    M1: Send + Sync + 'static,
    M2: Send + Sync + 'static, 

Send a single unary gRPC request.

pub async fn client_streaming<'_, S, M1, M2, C>(
    &'_ mut self,
    request: Request<S>,
    path: PathAndQuery,
    codec: C
) -> Result<Response<M2>, Status> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    <T::ResponseBody as HttpBody>::Error: Into<Box<dyn Error + Send + Sync>>,
    S: Stream<Item = M1> + Send + Sync + 'static,
    C: Codec<Encode = M1, Decode = M2>,
    M1: Send + Sync + 'static,
    M2: Send + Sync + 'static, 

Send a client side streaming gRPC request.

pub async fn server_streaming<'_, M1, M2, C>(
    &'_ mut self,
    request: Request<M1>,
    path: PathAndQuery,
    codec: C
) -> Result<Response<Streaming<M2>>, Status> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    <T::ResponseBody as HttpBody>::Error: Into<Box<dyn Error + Send + Sync>>,
    C: Codec<Encode = M1, Decode = M2>,
    M1: Send + Sync + 'static,
    M2: Send + Sync + 'static, 

Send a server side streaming gRPC request.

pub async fn streaming<'_, S, M1, M2, C>(
    &'_ mut self,
    request: Request<S>,
    path: PathAndQuery,
    __arg3: C
) -> Result<Response<Streaming<M2>>, Status> where
    T: GrpcService<BoxBody>,
    T::ResponseBody: Body + HttpBody + Send + 'static,
    <T::ResponseBody as HttpBody>::Error: Into<Box<dyn Error + Send + Sync>>,
    S: Stream<Item = M1> + Send + Sync + 'static,
    C: Codec<Encode = M1, Decode = M2>,
    M1: Send + Sync + 'static,
    M2: Send + Sync + 'static, 

Send a bi-directional streaming gRPC request.

Trait Implementations

impl<T: Clone> Clone for Grpc<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.