talksik/tonic
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add docs to codec and server

Browse Source
This commit is contained in:
Lucio Franco
2019-09-04 18:02:44 -04:00
parent 77a6c89ae9
commit 031fcc9026
8 changed files with 59 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tonic/src/body.rs
-1
View File
@@ -96,7 +96,6 @@ impl HttpBody for BoxBody {
type Error = Status;
fn is_end_stream(&self) -> bool {
// Body::is_end_stream(&self.inner)
self.inner.is_end_stream()
}
tonic/src/client/grpc.rs
+6 -11
View File
@@ -62,10 +62,8 @@ impl<T> Grpc<T> {
<T::ResponseBody as HttpBody>::Error: Into<crate::Error>,
<T::ResponseBody as HttpBody>::Data: Into<Bytes>,
C: Codec<Encode = M1, Decode = M2>,
C::Encoder: Send + 'static,
C::Decoder: Send + 'static,
M1: Send + 'static,
{
M2: Send + 'static {
let request = request.map(|m| stream::once(future::ok(m)));
self.client_streaming(request, path, codec).await
}
@@ -84,9 +82,8 @@ impl<T> Grpc<T> {
<T::ResponseBody as HttpBody>::Data: Into<Bytes>,
S: Stream<Item = Result<M1, Status>> + Send + 'static,
C: Codec<Encode = M1, Decode = M2>,
C::Encoder: Send + 'static,
C::Decoder: Send + 'static,
M1: Send,
M1: Send + 'static,
M2: Send + 'static
{
let (mut parts, body) = self.streaming(request, path, codec).await?.into_parts();
@@ -117,9 +114,8 @@ impl<T> Grpc<T> {
<T::ResponseBody as HttpBody>::Error: Into<crate::Error>,
<T::ResponseBody as HttpBody>::Data: Into<Bytes>,
C: Codec<Encode = M1, Decode = M2>,
C::Encoder: Send + 'static,
C::Decoder: Send + 'static,
M1: Send + 'static,
M2: Send + 'static
{
let request = request.map(|m| stream::once(future::ok(m)));
self.streaming(request, path, codec).await
@@ -139,9 +135,8 @@ impl<T> Grpc<T> {
<T::ResponseBody as HttpBody>::Error: Into<crate::Error>,
S: Stream<Item = Result<M1, Status>> + Send + 'static,
C: Codec<Encode = M1, Decode = M2>,
C::Encoder: Send + 'static,
C::Decoder: Send + 'static,
M1: Send,
M1: Send + 'static,
M2: Send + 'static
{
let mut parts = Parts::default();
parts.path_and_query = Some(path);
tonic/src/client/mod.rs
+1 -1
View File
@@ -1,4 +1,4 @@
//! gRPC over HTTP2 client implementation.
//! gRPC client implementation.
//!
//! This module contains the low level components to build a gRPC client. It
//! provides a codec agnostic gRPC client dispatcher and a decorated tower
tonic/src/codec/decode.rs
+14 -16
View File
@@ -1,18 +1,17 @@
use super::Decoder;
use crate::body::BoxBody;
use crate::metadata::MetadataMap;
use crate::{Code, Status};
use crate::{Code, Status, BoxBody, metadata::MetadataMap};
use bytes::{Buf, BufMut, Bytes, BytesMut, IntoBuf};
use futures_core::Stream;
use futures_util::{future, ready};
use http::StatusCode;
use http_body::Body;
use std::fmt;
use std::pin::Pin;
use std::task::{Context, Poll};
use std::{fmt, pin::Pin, task::{Context, Poll}};
use tracing::{debug, trace};
// #[derive(Debug)]
/// Streaming requests and responses.
///
/// This will wrap some inner [`Body`] and [`Decoder`] and provide an interface
/// to fetch the message stream and trailing metadata
pub struct Streaming<T> {
decoder: Box<dyn Decoder<Item = T, Error = Status> + Send + 'static>,
body: BoxBody,
@@ -38,7 +37,7 @@ enum Direction {
}
impl<T> Streaming<T> {
pub fn new_response<B, D>(decoder: D, body: B, status_code: StatusCode) -> Self
pub(crate) fn new_response<B, D>(decoder: D, body: B, status_code: StatusCode) -> Self
where
B: Body + Send + 'static,
B::Data: Into<Bytes>,
@@ -48,7 +47,7 @@ impl<T> Streaming<T> {
Self::new(decoder, body, Direction::Response(status_code))
}
pub fn new_empty<B, D>(decoder: D, body: B) -> Self
pub(crate) fn new_empty<B, D>(decoder: D, body: B) -> Self
where
B: Body + Send + 'static,
B::Data: Into<Bytes>,
@@ -58,7 +57,7 @@ impl<T> Streaming<T> {
Self::new(decoder, body, Direction::EmptyResponse)
}
pub fn new_request<B, D>(decoder: D, body: B) -> Self
pub(crate) fn new_request<B, D>(decoder: D, body: B) -> Self
where
B: Body + Send + 'static,
B::Data: Into<Bytes>,
@@ -112,7 +111,7 @@ impl<T> Streaming<T> {
// Trailers were not caught during poll_next and thus lets poll for
// them manually.
let map =
future::poll_fn(|cx| unsafe { Pin::new_unchecked(&mut self.body) }.poll_trailers(cx))
future::poll_fn(|cx| Pin::new(&mut self.body).poll_trailers(cx))
.await
.map_err(|e| Status::from_error(&e))?;
@@ -189,8 +188,7 @@ impl<T> Stream for Streaming<T> {
None => (),
}
// FIXME: Figure out how to verify that this is safe
let chunk = match ready!(unsafe { Pin::new_unchecked(&mut self.body) }.poll_data(cx)) {
let chunk = match ready!(Pin::new(&mut self.body).poll_data(cx)) {
Some(Ok(d)) => Some(d),
Some(Err(e)) => {
let err: crate::Error = e.into();
@@ -205,7 +203,7 @@ impl<T> Stream for Streaming<T> {
if let Some(data) = chunk {
self.buf.put(data);
} else {
// FIXME: get BytesMut to impl `Buf` directlty?
// TODO: get BytesMut to impl `Buf` directlty?
let buf1 = (&self.buf[..]).into_buf();
if buf1.has_remaining() {
trace!("unexpected EOF decoding stream");
@@ -220,7 +218,7 @@ impl<T> Stream for Streaming<T> {
}
if let Direction::Response(status) = self.direction {
match ready!(unsafe { Pin::new_unchecked(&mut self.body) }.poll_trailers(cx)) {
match ready!(Pin::new(&mut self.body).poll_trailers(cx)) {
Ok(trailer) => {
if let Err(e) = crate::status::infer_grpc_status(trailer.as_ref(), status) {
return Some(Err(e)).into();
@@ -243,6 +241,6 @@ impl<T> Stream for Streaming<T> {
impl<T> fmt::Debug for Streaming<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
write!(f, "Streaming")
f.debug_struct("Streaming").finish()
}
}
tonic/src/codec/mod.rs
+23 -6
View File
@@ -1,23 +1,40 @@
//! gRPC encoding and decoding.
//!
//! This module contains the generic `Codec` trait and a protobuf codec
//! based on prost.
mod decode;
mod encode;
mod prost;
pub use self::decode::Streaming;
pub use self::encode::{encode_client, encode_server, EncodeBody};
pub(crate) use self::encode::{encode_client, encode_server};
pub use self::prost::ProstCodec;
pub use tokio_codec::{Decoder, Encoder};
use crate::Status;
use tokio_codec::{Decoder, Encoder};
/// Triat that knows how to encode and decode gRPC messages.
pub trait Codec {
type Encode;
type Decode;
/// The encodable message.
type Encode: Send + 'static;
/// The decodable message.
type Decode: Send + 'static;
type Encoder: Encoder<Item = Self::Encode, Error = Status>;
type Decoder: Decoder<Item = Self::Decode, Error = Status>;
/// The encoder that can encode a message.
type Encoder: Encoder<Item = Self::Encode, Error = Status> + Send + 'static;
/// The encoder that can decode a message.
type Decoder: Decoder<Item = Self::Decode, Error = Status> + Send + 'static;
/// The content type of this codec.
///
/// This should follow the `Content-Type` definition [here].
///
/// [here]: https://github.com/grpc/grpc/blob/master/doc/PROTOCOL-HTTP2.md#requests
const CONTENT_TYPE: &'static str;
/// Fetch the encoder.
fn encoder(&mut self) -> Self::Encoder;
/// Fetch the decoder.
fn decoder(&mut self) -> Self::Decoder;
}
tonic/src/codec/prost.rs
+7 -4
View File
@@ -1,16 +1,17 @@
use super::Codec;
use super::{Codec, Decoder, Encoder};
use crate::{Code, Status};
use bytes::{BufMut, BytesMut};
use prost::Message;
use std::marker::PhantomData;
use tokio_codec::{Decoder, Encoder};
/// A [`Codec`] that implements `application/grpc+proto` via the prost library..
#[derive(Debug, Clone)]
pub struct ProstCodec<T, U> {
_pd: PhantomData<(T, U)>,
}
impl<T, U> ProstCodec<T, U> {
/// Create a new codec that knows how to encode `T` and decode `U`.
pub fn new() -> Self {
Self { _pd: PhantomData }
}
@@ -18,8 +19,8 @@ impl<T, U> ProstCodec<T, U> {
impl<T, U> Codec for ProstCodec<T, U>
where
T: Message,
U: Message + Default,
T: Message + Send + 'static,
U: Message + Default + Send + 'static,
{
type Encode = T;
type Decode = U;
@@ -38,6 +39,7 @@ where
}
}
/// A [`Encoder`] that knows how to encode `T`.
pub struct ProstEncoder<T>(PhantomData<T>);
impl<T: Message> Encoder for ProstEncoder<T> {
@@ -56,6 +58,7 @@ impl<T: Message> Encoder for ProstEncoder<T> {
}
}
/// A [`Decoder`] that knows how to decode `U`.
pub struct ProstDecoder<U>(PhantomData<U>);
impl<U: Message + Default> Decoder for ProstDecoder<U> {
tonic/src/server/grpc.rs
+7 -6
View File
@@ -7,6 +7,7 @@ use bytes::Bytes;
use futures_core::TryStream;
use futures_util::{future, stream, TryStreamExt};
use http_body::Body;
use std::fmt;
/// A gRPC Server handler.
///
@@ -24,10 +25,6 @@ pub struct Grpc<T> {
impl<T> Grpc<T>
where
T: Codec,
T::Decoder: Send + 'static,
T::Decode: Send + Unpin + 'static,
T::Encoder: Send + 'static,
T::Encode: Send + Unpin + 'static,
{
/// Creates a new gRPC client with the provided [`Codec`].
pub fn new(codec: T) -> Self {
@@ -97,8 +94,6 @@ where
) -> http::Response<BoxBody>
where
S: ClientStreamingService<Streaming<T::Decode>, Response = T::Encode>,
T::Decode: Send + 'static,
T::Decoder: Send + 'static,
B: Body + Send + 'static,
B::Data: Into<Bytes> + Send + 'static,
B::Error: Into<crate::Error> + Send + 'static,
@@ -205,3 +200,9 @@ where
}
}
}
impl<T> fmt::Debug for Grpc<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.debug_struct("Grpc").finish()
}
}
tonic/src/server/mod.rs
+1 -1
View File
@@ -1,4 +1,4 @@
//! gRPC over HTTP2 server implementation.
//! gRPC server implementation.
//!
//! This module contains the low level components to build a gRPC server. It
//! provides a codec agnostic gRPC server handler.