Files
tarpc/src/protocol/mod.rs
Tim be5f55c5f6 Extend snake_to_camel plugin to replace {} in the doc string with the original snake-cased ident. (#50)
* Extend snake_to_camel plugin to replace {} in the doc string with the origin snake-cased ident.

Also, track tokio-rs master.

This is really ad-hoc, undiscoverable, and unintuitive, but there's no way to programmatically create doc strings
in regular code, and I want to produce better doc strings for the associated types.

Given `fn foo_bar`:

Before: `/// The type of future returned by the function of the same name.`
After: ``/// The type of future returned by `{}`.``
    => `/// The type of future returned by foo_bar.`

* Fix some docs

* Use a helper fn on pipeline::Frame instead of handrolled match.

* Don't hide docs for ClientFuture.

It's exposed in the Connect impl of FutureService -- the tradeoff for not generating *another* item -- and hiding it breaks doc links.

* Formatting

* Rename snake_to_camel plugin => tarpc-plugins

* Update README

* Mangle a lot of names in macro expansion.

To lower the chance of any issues, prefix idents in service expansion with __tarpc_service.
In future_enum, prefix with __future_enum. The pattern is basically __macro_name_ident.

Any imported enum variant will conflict with a let binding or a function arg, so we basically
can't use any generic idents at all. Example:

    enum Req { request(..) }
    use self::Req::request;

    fn make_request(request: Request) { ... }

                    ^^^^^^^ conflict here

Additionally, suffix generated associated types with Fut to avoid conflicts with camelcased rpcs.
Why someone would do that, I don't know, but we shouldn't allow that wart.
2016-09-14 01:19:24 -07:00

110 lines
3.0 KiB
Rust

// Copyright 2016 Google Inc. All Rights Reserved.
//
// Licensed under the MIT License, <LICENSE or http://opensource.org/licenses/MIT>.
// This file may not be copied, modified, or distributed except according to those terms.
use serde;
use futures::{self, Async};
use bincode::{SizeLimit, serde as bincode};
use std::{io, thread};
use std::collections::VecDeque;
use std::sync::mpsc;
use util::Never;
use tokio_core::io::{FramedIo, Io};
use tokio_core::reactor::{Core, Remote};
use tokio_proto::pipeline::Frame;
lazy_static! {
#[doc(hidden)]
pub static ref LOOP_HANDLE: Remote = {
let (tx, rx) = mpsc::channel();
thread::spawn(move || {
let mut lupe = Core::new().unwrap();
tx.send(lupe.handle().remote().clone()).unwrap();
// Run forever
lupe.run(futures::empty::<(), !>()).unwrap();
});
rx.recv().unwrap()
};
}
pub use self::writer::Packet;
pub mod reader;
pub mod writer;
/// A helper trait to provide the `map_non_block` function on Results.
trait MapNonBlock<T> {
/// Maps a `Result<T>` to a `Result<Option<T>>` by converting
/// operation-would-block errors into `Ok(None)`.
fn map_non_block(self) -> io::Result<Option<T>>;
}
impl<T> MapNonBlock<T> for io::Result<T> {
fn map_non_block(self) -> io::Result<Option<T>> {
use std::io::ErrorKind::WouldBlock;
match self {
Ok(value) => Ok(Some(value)),
Err(err) => {
if let WouldBlock = err.kind() {
Ok(None)
} else {
Err(err)
}
}
}
}
}
/// Deserialize a buffer into a `D` and its ID. On error, returns `tarpc::Error`.
pub fn deserialize<D: serde::Deserialize>(mut buf: &[u8]) -> Result<D, bincode::DeserializeError> {
bincode::deserialize_from(&mut buf, SizeLimit::Infinite)
}
pub struct TarpcTransport<T> {
stream: T,
read_state: reader::ReadState,
outbound: VecDeque<Packet>,
head: Option<Packet>,
}
impl<T> TarpcTransport<T> {
pub fn new(stream: T) -> Self {
TarpcTransport {
stream: stream,
read_state: reader::ReadState::init(),
outbound: VecDeque::new(),
head: None,
}
}
}
impl<T> FramedIo for TarpcTransport<T>
where T: Io
{
type In = Frame<Packet, Never, io::Error>;
type Out = Frame<Vec<u8>, Never, io::Error>;
fn poll_read(&mut self) -> Async<()> {
self.stream.poll_read()
}
fn poll_write(&mut self) -> Async<()> {
self.stream.poll_write()
}
fn read(&mut self) -> io::Result<Async<Frame<Vec<u8>, Never, io::Error>>> {
self.read_state.next(&mut self.stream)
}
fn write(&mut self, req: Self::In) -> io::Result<Async<()>> {
self.outbound.push_back(req.unwrap_msg());
self.flush()
}
fn flush(&mut self) -> io::Result<Async<()>> {
writer::NextWriteState::next(&mut self.head, &mut self.stream, &mut self.outbound)
}
}