1
0
mirror of https://github.com/fafhrd91/actix-web synced 2025-08-20 12:45:41 +02:00

update docs

This commit is contained in:
Nikolay Kim
2017-10-07 23:59:57 -07:00
parent 01e9a7d77e
commit 4102b9e1c5
6 changed files with 89 additions and 10 deletions

View File

@@ -11,7 +11,24 @@ use context::HttpContext;
use httpcodes::HTTPMethodNotAllowed;
use httpmessage::{HttpRequest, HttpResponse, IntoHttpResponse};
/// Resource
/// Http resource
///
/// `HttpResource` is an entry in route table which corresponds to requested URL.
///
/// Resource in turn has at least one route.
/// Route corresponds to handling HTTP method by calling route handler.
///
/// ```rust,ignore
///
/// struct MyRoute;
///
/// fn main() {
/// let mut routes = RoutingMap::default();
///
/// routes
/// .add_resource("/")
/// .post::<MyRoute>();
/// }
pub struct HttpResource<S=()> {
state: PhantomData<S>,
routes: HashMap<Method, Box<RouteHandler<S>>>,
@@ -91,6 +108,7 @@ enum HttpMessageItem<A> where A: Actor<Context=HttpContext<A>> + Route {
Actor(A),
}
/// Represents response process.
pub struct HttpMessage<A: Actor<Context=HttpContext<A>> + Route> (HttpMessageItem<A>);
impl<A> HttpMessage<A> where A: Actor<Context=HttpContext<A>> + Route