1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

// Copyright 2018 Google LLC
//
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT.

//! Provides a [`Transport`] trait as well as implementations.
//!
//! The rpc crate is transport- and protocol-agnostic. Any transport that impls [`Transport`]
//! can be plugged in, using whatever protocol it wants.

use futures::prelude::*;
use std::{
    io,
    marker::PhantomData,
    net::SocketAddr,
    pin::Pin,
    task::{Context, Poll},
};

pub mod channel;

/// A bidirectional stream ([`Sink`] + [`Stream`]) of messages.
pub trait Transport
where
    Self: Stream<Item = io::Result<<Self as Transport>::Item>>,
    Self: Sink<<Self as Transport>::SinkItem, SinkError = io::Error>,
{
    /// The type read off the transport.
    type Item;
    /// The type written to the transport.
    type SinkItem;

    /// The address of the remote peer this transport is in communication with.
    fn peer_addr(&self) -> io::Result<SocketAddr>;
    /// The address of the local half of this transport.
    fn local_addr(&self) -> io::Result<SocketAddr>;
}

/// Returns a new Transport backed by the given Stream + Sink and connecting addresses.
pub fn new<S, SinkItem, Item>(
    inner: S,
    peer_addr: SocketAddr,
    local_addr: SocketAddr,
) -> impl Transport<Item = Item, SinkItem = SinkItem>
where
    S: Stream<Item = io::Result<Item>>,
    S: Sink<SinkItem, SinkError = io::Error>,
{
    TransportShim {
        inner,
        peer_addr,
        local_addr,
        _marker: PhantomData,
    }
}

/// A transport created by adding peers to a Stream + Sink.
#[derive(Debug)]
struct TransportShim<S, SinkItem> {
    peer_addr: SocketAddr,
    local_addr: SocketAddr,
    inner: S,
    _marker: PhantomData<SinkItem>,
}

impl<S, SinkItem> TransportShim<S, SinkItem> {
    pin_utils::unsafe_pinned!(inner: S);
}

impl<S, SinkItem> Stream for TransportShim<S, SinkItem>
where
    S: Stream,
{
    type Item = S::Item;

    fn poll_next(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<S::Item>> {
        self.inner().poll_next(cx)
    }
}

impl<S, Item> Sink<Item> for TransportShim<S, Item>
where
    S: Sink<Item>,
{
    type SinkError = S::SinkError;

    fn start_send(self: Pin<&mut Self>, item: Item) -> Result<(), S::SinkError> {
        self.inner().start_send(item)
    }

    fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), S::SinkError>> {
        self.inner().poll_ready(cx)
    }

    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), S::SinkError>> {
        self.inner().poll_flush(cx)
    }

    fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), S::SinkError>> {
        self.inner().poll_close(cx)
    }
}

impl<S, SinkItem, Item> Transport for TransportShim<S, SinkItem>
where
    S: Stream + Sink<SinkItem>,
    Self: Stream<Item = io::Result<Item>>,
    Self: Sink<SinkItem, SinkError = io::Error>,
{
    type Item = Item;
    type SinkItem = SinkItem;

    /// The address of the remote peer this transport is in communication with.
    fn peer_addr(&self) -> io::Result<SocketAddr> {
        Ok(self.peer_addr)
    }

    /// The address of the local half of this transport.
    fn local_addr(&self) -> io::Result<SocketAddr> {
        Ok(self.local_addr)
    }
}