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
//! web context types.
use core::{
cell::{Ref, RefCell, RefMut},
mem,
};
use super::{
body::{RequestBody, ResponseBody},
http::{BorrowReq, BorrowReqMut, IntoResponse, Request, RequestExt, WebRequest, WebResponse},
};
/// web context type focus on stateful and side effect based request data access.
pub struct WebContext<'a, C = (), B = RequestBody> {
pub(crate) req: &'a mut WebRequest<()>,
pub(crate) body: &'a mut RefCell<B>,
pub(crate) ctx: &'a C,
}
impl<'a, C, B> WebContext<'a, C, B> {
pub(crate) fn new(req: &'a mut WebRequest<()>, body: &'a mut RefCell<B>, ctx: &'a C) -> Self {
Self { req, body, ctx }
}
/// Reborrow Self so the ownership of WebRequest is not lost.
///
/// # Note:
///
/// Reborrow is not pure and receiver of it can mutate Self in any way they like.
///
/// # Example:
/// ```rust
/// # use xitca_web::WebContext;
/// // a function need ownership of request but not return it in output.
/// fn handler(req: WebContext<'_>) -> Result<(), ()> {
/// Err(())
/// }
///
/// # fn call(mut req: WebContext<'_>) {
/// // use reborrow to avoid pass request by value.
/// match handler(req.reborrow()) {
/// // still able to access request after handler return.
/// Ok(_) => assert_eq!(req.state(), &()),
/// Err(_) => assert_eq!(req.state(), &())
/// }
/// # }
/// ```
#[inline]
pub fn reborrow(&mut self) -> WebContext<'_, C, B> {
WebContext {
req: self.req,
body: self.body,
ctx: self.ctx,
}
}
/// Get an immutable reference of App state
#[inline]
pub fn state(&self) -> &C {
self.ctx
}
/// Get an immutable reference of [WebRequest]
#[inline]
pub fn req(&self) -> &WebRequest<()> {
self.req
}
/// Get a mutable reference of [WebRequest]
#[inline]
pub fn req_mut(&mut self) -> &mut WebRequest<()> {
self.req
}
/// Get a immutable reference of [RequestBody]
#[inline]
pub fn body(&self) -> Ref<'_, B> {
self.body.borrow()
}
/// Get a mutable reference of [RequestBody]
#[inline]
pub fn body_borrow_mut(&self) -> RefMut<'_, B> {
self.body.borrow_mut()
}
/// Get a mutable reference of [RequestBody]
/// This API takes &mut WebRequest so it bypass runtime borrow checker
/// and therefore has zero runtime overhead.
#[inline]
pub fn body_get_mut(&mut self) -> &mut B {
self.body.get_mut()
}
pub fn take_request(&mut self) -> WebRequest<B>
where
B: Default,
{
let head = mem::take(self.req_mut());
let body = self.take_body_mut();
head.map(|ext| ext.map_body(|_| body))
}
/// Transform self to a WebResponse with given body type.
///
/// The heap allocation of request would be re-used.
#[inline]
pub fn into_response<ResB: Into<ResponseBody>>(self, body: ResB) -> WebResponse {
self.req.as_response(body.into())
}
/// Transform &mut self to a WebResponse with given body type.
///
/// The heap allocation of request would be re-used.
#[inline]
pub fn as_response<ResB: Into<ResponseBody>>(&mut self, body: ResB) -> WebResponse {
self.req.as_response(body.into())
}
pub(crate) fn take_body_ref(&self) -> B
where
B: Default,
{
mem::take(&mut *self.body_borrow_mut())
}
pub(crate) fn take_body_mut(&mut self) -> B
where
B: Default,
{
mem::take(self.body_get_mut())
}
}
impl<C, B, T> BorrowReq<T> for WebContext<'_, C, B>
where
Request<RequestExt<()>>: BorrowReq<T>,
{
fn borrow(&self) -> &T {
self.req().borrow()
}
}
impl<C, B, T> BorrowReqMut<T> for WebContext<'_, C, B>
where
Request<RequestExt<()>>: BorrowReqMut<T>,
{
fn borrow_mut(&mut self) -> &mut T {
self.req_mut().borrow_mut()
}
}
#[cfg(test)]
pub(crate) struct TestWebContext<C> {
pub(crate) req: Request<RequestExt<()>>,
pub(crate) body: RefCell<RequestBody>,
pub(crate) ctx: C,
}
#[cfg(test)]
impl<C> TestWebContext<C> {
pub(crate) fn as_web_ctx(&mut self) -> WebContext<'_, C> {
WebContext {
req: &mut self.req,
body: &mut self.body,
ctx: &self.ctx,
}
}
}
#[cfg(test)]
impl<C> WebContext<'_, C> {
pub(crate) fn new_test(ctx: C) -> TestWebContext<C> {
TestWebContext {
req: Request::new(RequestExt::default()),
body: RefCell::new(RequestBody::None),
ctx,
}
}
}