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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
//! Components for constructing `Endpoint`.

mod boxed;
pub mod ext;
pub mod syntax;

// re-exports
pub use self::{
    boxed::{EndpointObj, LocalEndpointObj},
    ext::EndpointExt,
};

use {
    crate::{
        action::{
            EndpointAction, //
            Oneshot,
            OneshotAction,
            PreflightContext,
        },
        common::Tuple,
        error::Error,
    },
    std::{rc::Rc, sync::Arc},
};

/// A trait indicating that the type has an implementation of `Endpoint<Bd>`.
///
/// The purpose of this trait is to implement the extension methods to `Endpoint`s
/// in situation when the type of request body is unknown.
pub trait IsEndpoint {
    /// Converts this endpoint into an `EndpointObj`.
    fn boxed<Bd, T>(self) -> EndpointObj<Bd, T>
    where
        Self: Endpoint<Bd, Output = T> + Send + Sync + 'static + Sized,
        Self::Action: Send + 'static,
        T: Tuple,
    {
        EndpointObj::new(self)
    }

    /// Converts this endpoint into a `LocalEndpointObj`.
    fn boxed_local<Bd, T>(self) -> LocalEndpointObj<Bd, T>
    where
        Self: Endpoint<Bd, Output = T> + 'static + Sized,
        Self::Action: 'static,
        T: Tuple,
    {
        LocalEndpointObj::new(self)
    }
}

impl<'a, E: IsEndpoint + ?Sized> IsEndpoint for &'a E {}
impl<E: IsEndpoint + ?Sized> IsEndpoint for Box<E> {}
impl<E: IsEndpoint + ?Sized> IsEndpoint for Rc<E> {}
impl<E: IsEndpoint + ?Sized> IsEndpoint for Arc<E> {}

/// Trait representing an endpoint, the main trait for abstracting
/// HTTP services in Finchers.
///
/// The endpoint behaves as an *asynchronous* process that takes
/// an HTTP request and convert it into a value of the associated type.
/// The process that handles an request is abstracted by `EndpointAction`,
/// and that instances are constructed by `Endpoint` for each request.
pub trait Endpoint<Bd>: IsEndpoint {
    /// The type of value that will be returned from `Action`.
    type Output: Tuple;

    /// The type of `EndpointAction` associated with this endpoint.
    type Action: EndpointAction<Bd, Output = Self::Output>;

    /// Spawns an instance of `Action` that applies to an request.
    fn action(&self) -> Self::Action;

    /// Add an annotation that the associated type `Output` is fixed to `T`.
    #[inline(always)]
    fn with_output<T: Tuple>(self) -> Self
    where
        Self: Endpoint<Bd, Output = T> + Sized,
    {
        self
    }
}

impl<'a, E, Bd> Endpoint<Bd> for &'a E
where
    E: Endpoint<Bd>,
{
    type Output = E::Output;
    type Action = E::Action;

    fn action(&self) -> Self::Action {
        (**self).action()
    }
}

impl<E, Bd> Endpoint<Bd> for Box<E>
where
    E: Endpoint<Bd>,
{
    type Output = E::Output;
    type Action = E::Action;

    fn action(&self) -> Self::Action {
        (**self).action()
    }
}

impl<E, Bd> Endpoint<Bd> for Rc<E>
where
    E: Endpoint<Bd>,
{
    type Output = E::Output;
    type Action = E::Action;

    fn action(&self) -> Self::Action {
        (**self).action()
    }
}

impl<E, Bd> Endpoint<Bd> for Arc<E>
where
    E: Endpoint<Bd>,
{
    type Output = E::Output;
    type Action = E::Action;

    fn action(&self) -> Self::Action {
        (**self).action()
    }
}

/// Create an endpoint from the specified closure that returns an `EndpointAction`.
pub fn endpoint<Bd, R>(
    f: impl Fn() -> R,
) -> impl Endpoint<
    Bd, //
    Output = R::Output,
    Action = R,
>
where
    R: EndpointAction<Bd>,
{
    #[allow(missing_debug_implementations)]
    struct ApplyEndpoint<F>(F);

    impl<F> IsEndpoint for ApplyEndpoint<F> {}

    impl<F, Bd, R> Endpoint<Bd> for ApplyEndpoint<F>
    where
        F: Fn() -> R,
        R: EndpointAction<Bd>,
    {
        type Output = R::Output;
        type Action = R;

        fn action(&self) -> Self::Action {
            (self.0)()
        }
    }

    ApplyEndpoint(f)
}

/// Create an endpoint which simply returns an unit (`()`).
#[inline]
pub fn unit<Bd>() -> impl Endpoint<
    Bd,
    Output = (),
    Action = Oneshot<self::unit::UnitAction>, // private
> {
    endpoint(|| self::unit::UnitAction(()).into_action())
}

mod unit {
    use super::*;

    #[allow(missing_debug_implementations)]
    pub struct UnitAction(pub(super) ());

    impl OneshotAction for UnitAction {
        type Output = ();

        fn preflight(self, _: &mut PreflightContext<'_>) -> Result<Self::Output, Error> {
            Ok(())
        }
    }
}

/// Create an endpoint which simply clones the specified value.
///
/// # Example
///
/// ```
/// # use finchers::prelude::*;
/// # use finchers::endpoint::value;
/// # use finchers::endpoint::syntax::path;
/// #
/// #[derive(Clone)]
/// struct Conn {
///     // ...
/// #   _p: (),
/// }
///
/// # fn endpoint<Bd>() -> impl Endpoint<Bd> {
/// let conn = {
///     // do some stuff...
/// #   Conn { _p: () }
/// };
///
/// let endpoint = path!(@get "/posts/<u32>")
///     .and(value(conn))
///     .and_then(|id: u32, conn: Conn| {
///         // ...
/// #       drop(id);
/// #       futures::future::ok::<_, finchers::util::Never>(conn)
///     });
/// # endpoint
/// # }
/// # fn main() {
/// # drop(endpoint::<()>());
/// # }
/// ```
#[inline]
pub fn value<Bd, T: Clone>(
    x: T,
) -> impl Endpoint<
    Bd,
    Output = (T,),
    Action = Oneshot<self::value::ValueAction<T>>, // private
> {
    endpoint(move || self::value::ValueAction { x: x.clone() }.into_action())
}

mod value {
    use super::*;

    // not a public API.
    #[derive(Debug)]
    pub struct ValueAction<T> {
        pub(super) x: T,
    }

    impl<T> OneshotAction for ValueAction<T> {
        type Output = (T,);

        fn preflight(self, _: &mut PreflightContext<'_>) -> Result<Self::Output, Error> {
            Ok((self.x,))
        }
    }
}

// ==== EndpointAction ====