ohkami 0.24.9

A performant, declarative, and runtime-flexible web framework for Rust
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

use crate::{IntoResponse, Request};

#[cfg(feature = "openapi")]
use crate::openapi;

/// "Retirieved from a `Request`".
///
/// ### required
/// - `type Errpr: IntoResponse`
/// - `fn from_request(req: &Request) -> Option<Result<Self, Self::Error>>`
///
/// Of course, you can manually implement for your structs that can be extracted from a request：
///
/// <br>
///
/// *example.rs*
/// ```
/// use ohkami::prelude::*;
///
/// struct IsGetRequest(bool);
///
/// impl ohkami::FromRequest<'_> for IsGetRequest {
///     type Error = std::convert::Infallible;
///     fn from_request(req: &Request) -> Option<Result<Self, Self::Error>> {
///         Some(Ok(Self(
///             req.method.isGET()
///         )))
///     }
/// }
/// ```
///
/// <br>
///
/// ### Note
///
/// *MUST NOT impl both `FromRequest` and `FromParam`*.
pub trait FromRequest<'req>: Sized {
    /// If this extraction never fails, `std::convert::Infallible` is recomended.
    type Error: IntoResponse;

    fn from_request(req: &'req Request) -> Option<Result<Self, Self::Error>>;

    #[cfg(feature = "openapi")]
    fn openapi_inbound() -> openapi::Inbound {
        openapi::Inbound::None
    }

    #[doc(hidden)]
    /// intent to be used by `claw::param::Path` and by the assertion in `router::base::Router::finalize`
    fn n_pathparams() -> usize {
        0
    }
}
const _: () = {
    impl<'req> FromRequest<'req> for &'req Request {
        type Error = std::convert::Infallible;
        fn from_request(req: &'req Request) -> Option<Result<Self, Self::Error>> {
            Some(Ok(req))
        }
    }
    impl<'req, FR: FromRequest<'req>> FromRequest<'req> for Option<FR> {
        type Error = FR::Error;

        #[inline]
        fn from_request(req: &'req Request) -> Option<Result<Self, Self::Error>> {
            match FR::from_request(req) {
                None => Some(Ok(None)),
                Some(fr) => Some(fr.map(Some)),
            }
        }

        #[cfg(feature = "openapi")]
        fn openapi_inbound() -> openapi::Inbound {
            FR::openapi_inbound()
        }
    }
};
#[cfg(feature = "rt_worker")]
const _: () = {
    impl<'req> FromRequest<'req> for &'req ::worker::Env {
        type Error = std::convert::Infallible;
        #[inline(always)]
        fn from_request(req: &'req Request) -> Option<Result<Self, Self::Error>> {
            Some(Ok(req.context.env()))
        }
    }
    impl<'req> FromRequest<'req> for &'req ::worker::Context {
        type Error = std::convert::Infallible;
        #[inline(always)]
        fn from_request(req: &'req Request) -> Option<Result<Self, Self::Error>> {
            Some(Ok(req.context.worker()))
        }
    }
};