coap 0.27.0

A CoAP library
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
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

use crate::router::{
    extract::FromRequest, macros::all_the_tuples, request::Request, response::IntoResponse,
};
use std::{future::Future, pin::Pin};

/// Trait for request handlers.
///
/// # Generics
///
/// - `T`: The type of parameters extracted from the request (e.g. path parameters, query parameters, etc.).
/// - `S`: The type of the router shared state that can be accessed by the handler.
pub trait Handler<T, S>: Clone + Send + Sync + 'static {
    /// The type of future calling this handler returns.
    type Future: Future<Output = Request> + Send + 'static;

    /// Call the handler with the given request.
    fn call(self, req: Request, state: S) -> Self::Future;
}

impl<S, F, Fut, Res> Handler<(), S> for F
where
    F: FnOnce() -> Fut + Clone + Send + Sync + 'static,
    Fut: Future<Output = Res> + Send,
    Res: IntoResponse + 'static,
{
    type Future = Pin<Box<dyn Future<Output = Request> + Send>>;

    fn call(self, mut req: Request, _state: S) -> Self::Future {
        Box::pin(async move {
            let result = self().await.into_response();
            result.fill_response(&mut req);
            req
        })
    }
}

/// A wrapper struct to allow cloning of handlers that implement the `Handler` trait.
pub struct HandlerWrapper<T, S, H: Handler<T, S>> {
    handler: H,
    _marker: std::marker::PhantomData<(T, S)>,
}

impl<T, S, H> HandlerWrapper<T, S, H>
where
    H: Handler<T, S> + 'static,
    T: 'static,
{
    /// Creates a new `HandlerWrapper` from a handler that implements the `Handler` trait.
    pub fn new(handler: H) -> Self {
        Self {
            handler,
            _marker: std::marker::PhantomData,
        }
    }
}

impl<T, S, H> Clone for HandlerWrapper<T, S, H>
where
    H: Handler<T, S> + Clone,
{
    fn clone(&self) -> Self {
        Self {
            handler: self.handler.clone(),
            _marker: std::marker::PhantomData,
        }
    }
}

/// Type-erased trait for [handlers](Handler) (no `T` parameter)
pub trait BoxableHandler<S>: Send + Sync + 'static {
    /// Call the handler with the given request and state.
    fn call(&self, req: Request, state: S) -> Pin<Box<dyn Future<Output = Request> + Send>>;

    /// Clone the handler into a boxed trait object.
    fn clone_box(&self) -> Box<dyn BoxableHandler<S>>;
}

// Enable cloning of boxed handlers
impl<S: 'static> Clone for Box<dyn BoxableHandler<S>> {
    fn clone(&self) -> Self {
        self.clone_box()
    }
}

impl<T, S, H> BoxableHandler<S> for HandlerWrapper<T, S, H>
where
    T: Sync + Send + 'static,
    S: Send + Sync + 'static,
    H: Handler<T, S> + Clone + Send + Sync + 'static,
{
    fn call(&self, req: Request, state: S) -> Pin<Box<dyn Future<Output = Request> + Send>> {
        let clone = self.clone();
        Box::pin(H::call(clone.handler, req, state))
    }
    fn clone_box(&self) -> Box<dyn BoxableHandler<S>> {
        Box::new(self.clone())
    }
}

/// Type alias for a boxed, type-erased [`Handler`].
pub type BoxedHandler<S> = Box<dyn BoxableHandler<S>>;

// Macro to implement Handler for tuples of parameters extracted from the request
macro_rules! impl_handler {
    (
        [$($ty:ident),*], $last:ident
    ) => {
        #[allow(non_snake_case, unused_mut)]
        impl<$($ty,)* $last, S, F, Fut, Res> Handler<($($ty,)* $last,), S> for F
        where
            S: Send + Sync + 'static,
            F: FnOnce($($ty,)* $last,) -> Fut + Clone + Send + Sync + 'static,
            Fut: Future<Output = Res> + Send,
            Res: IntoResponse,
            $( $ty: FromRequest<S> + Send, )*
            $last: FromRequest<S> + Send,
        {
            type Future = Pin<Box<dyn Future<Output = Request> + Send>>;

            fn call(self, mut req: Request, state: S) -> Self::Future {
                Box::pin(async move {
                    $(
                        let $ty = match $ty::from_request(&req, &state).await {
                            Ok(value) => value,
                            Err(rejection) => {
                                rejection.into_response().fill_response(&mut req);
                                return req;
                            }
                        };
                    )*

                    let $last = match $last::from_request( &req, &state).await {
                        Ok(value) => value,
                        Err(rejection) => {
                            rejection.into_response().fill_response(&mut req);
                            return req;
                        }
                    };

                    let response = self($($ty,)* $last,).await;
                    response.into_response().fill_response(&mut req);
                    req
                })
            }
        }
    };
}

all_the_tuples!(impl_handler);