Skip to main content

Protocol

Enum Protocol 

Source
#[non_exhaustive]
pub enum Protocol { Connect, Grpc, GrpcWeb, }
Expand description

The wire protocol used for an RPC.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Connect

Connect protocol - HTTP-native with standard HTTP semantics.

Unary RPCs use bare message bodies and real HTTP status codes. Streaming RPCs use envelope framing with JSON end-of-stream messages.

§

Grpc

gRPC protocol - standard gRPC over HTTP/2.

All RPCs use envelope framing. Status is communicated via HTTP/2 trailing HEADERS (grpc-status, grpc-message). HTTP status is always 200.

§

GrpcWeb

gRPC-Web protocol - gRPC-Web for browser compatibility.

Like gRPC but works over HTTP/1.1. Trailers are encoded in the response body as a final frame with flag byte 0x80.

Implementations§

Source§

impl Protocol

Source

pub fn detect(headers: &HeaderMap) -> Option<RequestProtocol>

Detect the protocol, codec format, and streaming mode from request headers.

Returns None if the Content-Type doesn’t match any known protocol.

Source

pub fn detect_from_content_type(content_type: &str) -> Option<RequestProtocol>

Detect the protocol from a Content-Type string.

Returns None if the content type doesn’t match any known protocol.

Source

pub fn response_content_type( &self, format: CodecFormat, is_streaming: bool, ) -> &'static str

Get the Content-Type header value for a response with this protocol and codec.

Source

pub fn timeout_header(&self) -> &'static str

Get the timeout header name for this protocol.

Source

pub fn content_encoding_header(&self) -> &'static HeaderName

Get the content-encoding header name for this protocol (streaming).

Returns a pre-parsed HeaderName so callers can pass it directly to HeaderMap::insert without the from_bytes re-parse that Response::Builder::header(&str, _) does.

Source

pub fn accept_encoding_header(&self) -> &'static HeaderName

Get the accept-encoding header name for this protocol (streaming).

Source

pub fn uses_http_status_codes(&self) -> bool

Whether this protocol uses real HTTP status codes for errors.

Connect uses standard HTTP status codes for unary errors. gRPC and gRPC-Web always return HTTP 200, with errors in trailers.

Source

pub fn requires_http2(&self) -> bool

Whether this protocol requires HTTP/2.

Source

pub fn uses_http_trailers(&self) -> bool

Whether this protocol sends trailers via HTTP/2 HEADERS frames.

gRPC uses HTTP/2 trailers; Connect and gRPC-Web encode trailers in the body.

Trait Implementations§

Source§

impl Clone for Protocol

Source§

fn clone(&self) -> Protocol

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Protocol

Source§

impl Debug for Protocol

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Protocol

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Protocol

Source§

impl Hash for Protocol

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Protocol

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Protocol

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

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>,

Source§

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<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