Skip to main content

Transcoder

Struct Transcoder 

Source
pub struct Transcoder { /* private fields */ }
Expand description

Transcodes application messages between JSON and binary protobuf, keyed by gRPC method path (/pkg.Service/Method), and maps google.api.http REST bindings onto gRPC methods.

Implementations§

Source§

impl Transcoder

Source

pub fn from_file_descriptor_set(bytes: &[u8]) -> Result<Self, TranscodeError>

Build from an encoded FileDescriptorSet.

Source

pub fn has_http_rules(&self) -> bool

Whether any google.api.http REST bindings were found.

Source

pub fn transcode_http_request( &self, method: &str, path: &str, query: Option<&str>, body: &[u8], ) -> Result<Option<HttpCall>, TranscodeError>

Map a REST request (method, path, query, body) onto a gRPC call, or Ok(None) if no HTTP binding matches.

Source

pub fn match_ws(&self, path: &str, query: Option<&str>) -> Option<WsBinding>

Resolve a WebSocket annotation route from its upgrade path, or None if the path matches no binding.

Source

pub fn is_annotated_method(&self, grpc_method: &str) -> bool

Whether a gRPC method has any HTTP annotation (used to keep an annotated RPC’s main route off the plain-HTTP surface).

Source

pub fn has_method(&self, path: &str) -> bool

Whether path (/pkg.Service/Method) resolves to a known method — i.e. this transcoder can handle it. Callers use it to distinguish “unknown method” (UNIMPLEMENTED) from a genuine transcode/validation failure.

Source

pub fn request_json_to_proto( &self, path: &str, json: &[u8], ) -> Result<Vec<u8>, TranscodeError>

JSON request message -> binary protobuf. Empty input is the default message.

Source

pub fn response_proto_to_json( &self, path: &str, proto: &[u8], ) -> Result<Vec<u8>, TranscodeError>

Binary protobuf response message -> JSON.

Trait Implementations§

Source§

impl Clone for Transcoder

Source§

fn clone(&self) -> Transcoder

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

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

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

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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, 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<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