chateau 0.3.2

Tower primitives for Servers and Clients with ergonomic APIs
Documentation 
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

//! Server-side connection builders.

use std::pin::Pin;
use std::task::{Context, Poll};

use pin_project::pin_project;
use tower::BoxError;
pub(super) mod drivers;

#[cfg(feature = "tls")]
pub mod tls;

/// A transport protocol for serving connections.
///
/// This is not meant to be the "accept" part of a server, but instead the connection
/// management and serving part.
pub trait Protocol<S, IO, Req> {
    /// The response type for the protocol.
    type Response: Send + 'static;

    /// The error when a connection has a problem.
    type Error: Into<BoxError>;

    /// The connection future, used to drive a connection IO to completion.
    type Connection: Connection + Future<Output = Result<(), Self::Error>> + 'static;

    /// Serve a connection with possible upgrades.
    ///
    /// Implementing this method does not guarantee that a protocol can be upgraded,
    /// just that we can serve the connection.
    fn serve_connection(&self, stream: IO, service: S) -> Self::Connection;
}

/// A connection that can be gracefully shutdown.
pub trait Connection {
    /// Gracefully shutdown the connection.
    fn graceful_shutdown(self: Pin<&mut Self>);
}

/// An async generator of new connections
pub trait Accept {
    /// The connection type for this acceptor
    type Connection: Unpin + 'static;

    /// The error type for this acceptor
    type Error: Into<BoxError>;

    /// Poll for a new connection
    fn poll_accept(
        self: Pin<&mut Self>,
        cx: &mut Context<'_>,
    ) -> Poll<Result<Self::Connection, Self::Error>>;
}

/// Extension trait for Accept
pub trait AcceptExt: Accept {
    /// Wrap the acceptor in a future that resolves to a single connection.
    fn accept(self) -> AcceptOne<Self>
    where
        Self: Sized,
    {
        AcceptOne::new(self)
    }
}

impl<A> AcceptExt for A where A: Accept {}

/// A future that resolves to a single connection
#[derive(Debug)]
#[pin_project]
pub struct AcceptOne<A> {
    #[pin]
    inner: A,
}

impl<A> AcceptOne<A> {
    fn new(inner: A) -> Self {
        AcceptOne { inner }
    }
}

impl<A> Future for AcceptOne<A>
where
    A: Accept,
{
    type Output = Result<A::Connection, A::Error>;

    fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output> {
        self.project().inner.poll_accept(cx)
    }
}