1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-12-24 17:10:33 +00:00
actix-web/README.md

82 lines
1.9 KiB
Markdown
Raw Normal View History

2017-10-08 21:56:51 +00:00
# Actix http [![Build Status](https://travis-ci.org/fafhrd91/actix-http.svg?branch=master)](https://travis-ci.org/fafhrd91/actix-http)
2017-09-30 16:16:59 +00:00
2017-10-07 08:12:43 +00:00
Actix http is a server http framework for Actix framework.
2017-09-30 16:16:59 +00:00
2017-10-14 14:59:35 +00:00
* [API Documentation](http://fafhrd91.github.io/actix-web/actix_web/)
2017-10-07 04:48:14 +00:00
* Cargo package: [actix-http](https://crates.io/crates/actix-http)
2017-10-07 06:14:13 +00:00
* Minimum supported Rust version: 1.20 or later
2017-09-30 16:16:59 +00:00
---
2017-10-08 21:56:51 +00:00
Actix http is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).
2017-09-30 16:16:59 +00:00
2017-10-07 08:12:43 +00:00
## Features
* HTTP 1.1 and 1.0 support
* Streaming and pipelining support
2017-10-13 23:33:23 +00:00
* Keep-alive and slow requests support
2017-10-14 14:59:35 +00:00
* [WebSockets support](https://fafhrd91.github.io/actix-web/actix_web/ws/index.html)
* [Configurable request routing](https://fafhrd91.github.io/actix-web/actix_web/struct.RoutingMap.html)
2017-09-30 16:16:59 +00:00
## Usage
2017-10-14 14:59:35 +00:00
To use `actix-web`, add this to your `Cargo.toml`:
2017-09-30 16:16:59 +00:00
```toml
[dependencies]
2017-10-14 14:59:35 +00:00
actix-web = { git = "https://github.com/fafhrd91/actix-web.git" }
2017-09-30 16:16:59 +00:00
```
2017-10-07 07:53:36 +00:00
## Example
```rust
extern crate actix;
2017-10-14 14:59:35 +00:00
extern crate actix_web;
2017-10-07 07:53:36 +00:00
extern crate futures;
use std::net;
use std::str::FromStr;
use actix::prelude::*;
2017-10-14 14:59:35 +00:00
use actix_web::*;
2017-10-07 07:53:36 +00:00
// Route
struct MyRoute;
impl Actor for MyRoute {
type Context = HttpContext<Self>;
}
impl Route for MyRoute {
type State = ();
2017-10-09 03:16:48 +00:00
fn request(req: HttpRequest, payload: Payload, ctx: &mut HttpContext<Self>) -> Reply<Self>
2017-10-07 07:53:36 +00:00
{
2017-10-13 23:33:23 +00:00
Reply::reply(httpcodes::HTTPOk)
2017-10-07 07:53:36 +00:00
}
}
fn main() {
2017-10-08 07:14:52 +00:00
let system = System::new("test");
2017-10-07 07:53:36 +00:00
// create routing map with `MyRoute` route
let mut routes = RoutingMap::default();
2017-10-08 04:48:00 +00:00
routes
.add_resource("/")
2017-10-07 07:53:36 +00:00
.post::<MyRoute>();
// start http server
let http = HttpServer::new(routes);
http.serve::<()>(
&net::SocketAddr::from_str("127.0.0.1:8880").unwrap()).unwrap();
// stop system
Arbiter::handle().spawn_fn(|| {
Arbiter::system().send(msgs::SystemExit(0));
futures::future::ok(())
});
system.run();
println!("Done");
}
```