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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
#![cfg(any(feature="rt_tokio",feature="rt_async-std",feature="rt_worker"))]
#[cfg(test)]
mod _test;
pub(crate) mod build;
pub(crate) mod router;
pub use build::{Route, Routes};
use crate::fangs::Fangs;
use std::sync::Arc;
use router::TrieRouter;
#[cfg(any(feature="rt_tokio",feature="rt_async-std"))]
use crate::{__rt__, Session};
#[cfg(feature="rt_async-std")] use crate::__rt__::StreamExt as _;
#[cfg(feature="websocket")] use crate::websocket::reserve_upgrade;
/// # Ohkami - a robust wolf who serves your web app
///
/// <br>
///
/// *example.rs*
/// ```
/// # use ohkami::prelude::*;
/// # use ohkami::serde::Serialize;
/// # use ohkami::typed::Payload;
/// # use ohkami::typed::status::{OK, Created};
/// # use ohkami::builtin::payload::JSON;
/// # use ohkami::{Fang, FangProc};
///
/// struct Auth;
/// impl<I: FangProc> Fang<I> for Auth {
/// /* 〜 */
/// # type Proc = AuthProc;
/// # fn chain(&self, inner: I) -> Self::Proc {
/// # AuthProc
/// # }
/// # }
/// # struct AuthProc;
/// # impl FangProc for AuthProc {
/// # async fn bite<'b>(&'b self, req: &'b mut Request) -> Response {
/// # Response::NotImplemented()
/// # }
/// # }
///
/// # #[Payload(JSON/S)]
/// # struct User {
/// # id: usize,
/// # name: String,
/// # age: Option<usize>,
/// # }
/// #
/// # enum APIError {
/// # UserNotFound
/// # }
/// # impl IntoResponse for APIError {
/// # fn into_response(self) -> Response {
/// # match self {
/// # Self::UserNotFound => Response::InternalServerError()
/// # }
/// # }
/// # }
/// #
/// # async fn health_check() -> impl IntoResponse {
/// # Status::NoContent
/// # }
/// #
/// # async fn create_user() -> Created<User> {
/// # Created(User {
/// # id: 42,
/// # name: String::from("ohkami"),
/// # age: None,
/// # })
/// # }
/// #
/// # async fn get_user_by_id(id: usize) -> Result<OK<User>, APIError> {
/// # Ok(OK(User {
/// # id,
/// # name: String::from("ohkami"),
/// # age: Some(2),
/// # }))
/// # }
/// #
/// # async fn update_user(id: usize) -> impl IntoResponse {
/// # Status::OK
/// # }
///
/// fn my_ohkami() -> Ohkami {
/// let api_ohkami = Ohkami::with((Auth,), (
/// "/users"
/// .POST(create_user),
/// "/users/:id"
/// .GET(get_user_by_id)
/// .PATCH(update_user),
/// ));
///
/// Ohkami::new((
/// "/hc" .GET(health_check),
/// "/api".By(api_ohkami),
/// ))
/// }
/// ```
///
/// <br>
///
/// #### handler schema:
/// `async ({path_params}?, {FromRequest type}s...) -> {IntoResponse type}`
///
/// #### path_params:
/// A tuple of types that implement `FromParam` trait.\
/// If the path contains only one parameter, then you can omit the tuple.\
/// (In current ohkami, at most *2* path params can be handled.)
///
/// <br>
///
/// ```
/// use ohkami::prelude::*;
///
/// struct MyParam;
/// impl<'p> ohkami::FromParam<'p> for MyParam {
/// type Error = std::convert::Infallible;
/// fn from_param(param: std::borrow::Cow<'p, str>) -> Result<Self, Self::Error> {
/// Ok(MyParam)
/// }
/// }
///
/// async fn handler_1(param: (MyParam,)) -> Response {
/// todo!()
/// }
///
/// async fn handler_2(str_param: &str) -> Response {
/// todo!()
/// }
/// ```
pub struct Ohkami {
pub(crate) routes: TrieRouter,
/// apply just before merged to another or called `howl`
pub(crate) fangs: Option<Arc<dyn Fangs>>,
}
impl Ohkami {
/// Create new `Ohkami` on the routing.
///
/// ---
///
/// `routes` is a routing item or a tuple of them :
///
/// ```
/// # use ohkami::Route;
/// #
/// # async fn handler1() -> &'static str {"1"}
/// # async fn handler2() -> &'static str {"2"}
/// # async fn handler3() -> &'static str {"3"}
/// #
/// # let _ =
/// (
/// "/a"
/// .GET(handler1)
/// .POST(handler2),
/// "/b"
/// .PUT(handler3),
/// //...
/// )
/// # ;
/// ```
///
/// ---
///
/// Handler is an _**async**_ function :
///
/// > `({path params}, {FromRequest values},...) -> {IntoResponse value}`
///
/// `{path params}` is a `FromParam` value or a tuple of them
pub fn new(routes: impl build::Routes) -> Self {
let mut router = TrieRouter::new();
routes.apply(&mut router);
Self {
routes: router,
fangs: None,
}
}
/// Create new ohkami with the fangs on the routing.
///
/// ---
///
/// `fangs: impl Fangs` is an tuple of `Fang` items.
///
/// **NOTE**: You can omit tuple when `fangs` contains only one `Fang`.
///
/// <br>
///
/// ---
///
/// ```
/// use ohkami::prelude::*;
///
/// #[derive(Clone)]
/// struct AuthFang;
/// impl FangAction for AuthFang {
/// //...
/// }
///
/// # async fn handler1() -> &'static str {"1"}
/// # async fn handler2() -> &'static str {"2"}
/// # async fn handler3() -> &'static str {"3"}
/// #
/// # let _ =
/// Ohkami::with(AuthFang, (
/// "/a"
/// .GET(handler1)
/// .POST(handler2),
/// "/b"
/// .PUT(handler3),
/// //...
/// ))
/// # ;
/// ```
pub fn with(fangs: impl Fangs + 'static, routes: impl build::Routes) -> Self {
let mut router = TrieRouter::new();
routes.apply(&mut router);
Self {
routes: router,
fangs: Some(Arc::new(fangs)),
}
}
#[cfg(any(feature="rt_tokio", feature="rt_async-std"))]
/// Start serving at `address`!
///
/// `address` is `{runtime}::net::ToSocketAddrs`:
///
/// - `tokio::net::ToSocketAddrs` if you use `tokio`
/// - `async_std::net::ToSocketAddrs` if you use `async-std`
///
/// <br>
///
/// *example.rs*
/// ```no_run
/// use ohkami::prelude::*;
/// use ohkami::typed::status::NoContent;
///
/// async fn hello() -> &'static str {
/// "Hello, ohkami!"
/// }
///
/// async fn health_check() -> NoContent {
/// NoContent
/// }
///
/// #[tokio::main]
/// async fn main() {
/// Ohkami::new((
/// "/".GET(hello),
/// "/healthz".GET(health_check),
/// )).howl("localhost:5000").await
/// }
/// ```
pub async fn howl(self, address: impl __rt__::ToSocketAddrs) {
let router = Arc::new(self.into_router().into_radix());
let listener = match __rt__::TcpListener::bind(address).await {
Ok(listener) => listener,
Err(e) => panic!("Failed to bind TCP listener: {e}"),
};
#[cfg(feature="rt_async-std")]
while let Some(connection) = listener.incoming().next().await {
let Ok(connection) = connection else {continue};
__rt__::task::spawn({
Session::new(
router.clone(),
connection,
).manage()
});
}
#[cfg(feature="rt_tokio")]
loop {
let Ok((connection, _)) = listener.accept().await else {continue};
__rt__::task::spawn({
Session::new(
router.clone(),
connection,
).manage()
});
}
}
#[cfg(feature="rt_worker")]
#[doc(hidden)]
pub async fn __worker__(self,
req: ::worker::Request,
env: ::worker::Env,
ctx: ::worker::Context,
) -> ::worker::Response {
#[cfg(feature="DEBUG")] ::worker::console_debug!("Called `#[ohkami::worker]`; req: {req:?}");
let mut ohkami_req = crate::Request::init();
#[cfg(feature="DEBUG")] ::worker::console_debug!("Done `ohkami::Request::init`");
let mut ohkami_req = unsafe {std::pin::Pin::new_unchecked(&mut ohkami_req)};
#[cfg(feature="DEBUG")] ::worker::console_debug!("Put request in `Pin`");
let take_over = ohkami_req.as_mut().take_over(req, env, ctx).await;
#[cfg(feature="DEBUG")] ::worker::console_debug!("Done `ohkami::Request::take_over`: {ohkami_req:?}");
let ohkami_res = match take_over {
Ok(()) => {#[cfg(feature="DEBUG")] ::worker::console_debug!("`take_over` succeed");
let router = self.into_router();
#[cfg(feature="DEBUG")] ::worker::console_debug!("Done `Ohkami::into_router`");
let router = router.into_radix();
#[cfg(feature="DEBUG")] ::worker::console_debug!("Done `TrieRouter::into_radix` (without compressions)");
router.handle(&mut ohkami_req).await
}
Err(e) => {#[cfg(feature="DEBUG")] ::worker::console_debug!("`take_over` returned an error response: {e:?}");
e
}
};
#[cfg(feature="DEBUG")] ::worker::console_debug!("Successfully generated ohkami::Response: {ohkami_res:?}");
let res = ohkami_res.into();
#[cfg(feature="DEBUG")] ::worker::console_debug!("Done `ohkami::Response` --into--> `worker::Response`: {res:?}");
res
}
}
impl Ohkami {
pub(crate) fn into_router(self) -> TrieRouter {
let Self { routes: mut router, fangs } = self;
if let Some(fangs) = fangs {
router.apply_fangs(router.id(), fangs);
}
#[cfg(feature="DEBUG")]
println!("{router:#?}");
router
}
}