1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-23 23:51:06 +01:00

add FramedRequest helper methods

This commit is contained in:
Nikolay Kim 2019-04-10 19:57:34 -07:00
parent 12e1dad42e
commit e55be4dba6
3 changed files with 147 additions and 12 deletions

View File

@ -206,7 +206,7 @@ where
let mut path = Path::new(Url::new(req.uri().clone())); let mut path = Path::new(Url::new(req.uri().clone()));
if let Some((srv, _info)) = self.router.recognize_mut(&mut path) { if let Some((srv, _info)) = self.router.recognize_mut(&mut path) {
return srv.call(FramedRequest::new(req, framed, self.state.clone())); return srv.call(FramedRequest::new(req, framed, path, self.state.clone()));
} }
Box::new( Box::new(
SendResponse::new(framed, Response::NotFound().finish()).then(|_| Ok(())), SendResponse::new(framed, Response::NotFound().finish()).then(|_| Ok(())),

View File

@ -1,5 +1,9 @@
use std::cell::{Ref, RefMut};
use actix_codec::Framed; use actix_codec::Framed;
use actix_http::{h1::Codec, Request}; use actix_http::http::{HeaderMap, Method, Uri, Version};
use actix_http::{h1::Codec, Extensions, Request, RequestHead};
use actix_router::{Path, Url};
use crate::state::State; use crate::state::State;
@ -7,24 +11,150 @@ pub struct FramedRequest<Io, S = ()> {
req: Request, req: Request,
framed: Framed<Io, Codec>, framed: Framed<Io, Codec>,
state: State<S>, state: State<S>,
pub(crate) path: Path<Url>,
} }
impl<Io, S> FramedRequest<Io, S> { impl<Io, S> FramedRequest<Io, S> {
pub fn new(req: Request, framed: Framed<Io, Codec>, state: State<S>) -> Self { pub fn new(
Self { req, framed, state } req: Request,
framed: Framed<Io, Codec>,
path: Path<Url>,
state: State<S>,
) -> Self {
Self {
req,
framed,
state,
path,
}
} }
} }
impl<Io, S> FramedRequest<Io, S> { impl<Io, S> FramedRequest<Io, S> {
pub fn request(&self) -> &Request { /// Split request into a parts
&self.req
}
pub fn request_mut(&mut self) -> &mut Request {
&mut self.req
}
pub fn into_parts(self) -> (Request, Framed<Io, Codec>, State<S>) { pub fn into_parts(self) -> (Request, Framed<Io, Codec>, State<S>) {
(self.req, self.framed, self.state) (self.req, self.framed, self.state)
} }
/// This method returns reference to the request head
#[inline]
pub fn head(&self) -> &RequestHead {
self.req.head()
}
/// This method returns muttable reference to the request head.
/// panics if multiple references of http request exists.
#[inline]
pub fn head_mut(&mut self) -> &mut RequestHead {
self.req.head_mut()
}
/// Shared application state
#[inline]
pub fn state(&self) -> &S {
self.state.get_ref()
}
/// Request's uri.
#[inline]
pub fn uri(&self) -> &Uri {
&self.head().uri
}
/// Read the Request method.
#[inline]
pub fn method(&self) -> &Method {
&self.head().method
}
/// Read the Request Version.
#[inline]
pub fn version(&self) -> Version {
self.head().version
}
#[inline]
/// Returns request's headers.
pub fn headers(&self) -> &HeaderMap {
&self.head().headers
}
/// The target path of this Request.
#[inline]
pub fn path(&self) -> &str {
self.head().uri.path()
}
/// The query string in the URL.
///
/// E.g., id=10
#[inline]
pub fn query_string(&self) -> &str {
if let Some(query) = self.uri().query().as_ref() {
query
} else {
""
}
}
/// Get a reference to the Path parameters.
///
/// Params is a container for url parameters.
/// A variable segment is specified in the form `{identifier}`,
/// where the identifier can be used later in a request handler to
/// access the matched value for that segment.
#[inline]
pub fn match_info(&self) -> &Path<Url> {
&self.path
}
/// Request extensions
#[inline]
pub fn extensions(&self) -> Ref<Extensions> {
self.head().extensions()
}
/// Mutable reference to a the request's extensions
#[inline]
pub fn extensions_mut(&self) -> RefMut<Extensions> {
self.head().extensions_mut()
}
}
#[cfg(test)]
mod tests {
use actix_http::test::{TestBuffer, TestRequest};
use super::*;
#[test]
fn test_reqest() {
let buf = TestBuffer::empty();
let framed = Framed::new(buf, Codec::default());
let req = TestRequest::with_uri("/index.html?q=1")
.header("content-type", "test")
.finish();
let path = Path::new(Url::new(req.uri().clone()));
let freq = FramedRequest::new(req, framed, path, State::new(10u8));
assert_eq!(*freq.state(), 10);
assert_eq!(freq.version(), Version::HTTP_11);
assert_eq!(freq.method(), Method::GET);
assert_eq!(freq.path(), "/index.html");
assert_eq!(freq.query_string(), "q=1");
assert_eq!(
freq.headers()
.get("content-type")
.unwrap()
.to_str()
.unwrap(),
"test"
);
freq.extensions_mut().insert(100usize);
assert_eq!(*freq.extensions().get::<usize>().unwrap(), 100usize);
let (_, _, state) = freq.into_parts();
assert_eq!(*state, 10);
}
} }

View File

@ -205,6 +205,11 @@ impl TestBuffer {
} }
} }
/// Create new empty TestBuffer instance
pub fn empty() -> TestBuffer {
TestBuffer::new("")
}
/// Add extra data to read buffer. /// Add extra data to read buffer.
pub fn extend_read_buf<T: AsRef<[u8]>>(&mut self, data: T) { pub fn extend_read_buf<T: AsRef<[u8]>>(&mut self, data: T) {
self.read_buf.extend_from_slice(data.as_ref()) self.read_buf.extend_from_slice(data.as_ref())