Struct RequestTimeouts 

pub struct RequestTimeouts { /* private fields */ }

Client-side time limits for a gRPC call. Both are off by default.

Set them for every call of a client with GoogleApiClient::with_request_timeouts, or for one call by inserting a value into the request’s extensions, which replaces both limits of the client for that call, so RequestTimeouts::new() switches them off:

let mut request: tonic::Request<M> = tonic::Request::new(message);
request
    .extensions_mut()
    .insert(RequestTimeouts::new().with_total(Duration::from_secs(10)));

A call that runs out of a limit fails with Code::DeadlineExceeded, and the status’s source() is a RequestTimeoutElapsed.

The limits bound the response body only when the service under the middleware answers with a tonic::body::Body, as the channel of a GoogleAuthMiddleware does. Over any other service they bound the wait for the response headers alone.

Implementations

impl RequestTimeouts

pub const fn new() -> Self

No limits: a call waits for as long as its connection lives.

pub const fn with_total(self, total: Duration) -> Self

The longest the whole call may take, from the request, its authentication included, to the last response message and the trailers.

Sent to the server as grpc-timeout, so a server that honours it stops working on the call too; a grpc-timeout the request already carries is kept. It ends a stream however steadily the stream delivers, so it suits unary calls.

pub const fn with_idle(self, idle: Duration) -> Self

The longest the caller waits for the response to start and for each next part of the response, counted only while the caller is waiting for one. Not sent to the server.

It suits server streams. A stream that stays quiet until the client writes, such as a bidirectional stream, fails on it.

Trait Implementations

impl Clone for RequestTimeouts

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RequestTimeouts

impl Debug for RequestTimeouts

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

Formats the value using the given formatter.

impl Default for RequestTimeouts

fn default() -> Self

Returns the “default value” for a type.

impl Eq for RequestTimeouts

impl PartialEq for RequestTimeouts

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RequestTimeouts