1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-30 18:34:36 +01:00
actix-extras/README.md

82 lines
2.0 KiB
Markdown
Raw Normal View History

2017-10-15 18:15:38 +02:00
# Actix http [![Build Status](https://travis-ci.org/fafhrd91/actix-web.svg?branch=master)](https://travis-ci.org/fafhrd91/actix-web) [![codecov](https://codecov.io/gh/fafhrd91/actix-web/branch/master/graph/badge.svg)](https://codecov.io/gh/fafhrd91/actix-web)
2017-09-30 18:16:59 +02:00
2017-10-07 10:12:43 +02:00
Actix http is a server http framework for Actix framework.
2017-09-30 18:16:59 +02:00
2017-10-14 16:59:35 +02:00
* [API Documentation](http://fafhrd91.github.io/actix-web/actix_web/)
2017-10-15 08:00:03 +02:00
* Cargo package: [actix-http](https://crates.io/crates/actix-web)
2017-10-07 08:14:13 +02:00
* Minimum supported Rust version: 1.20 or later
2017-09-30 18:16:59 +02:00
---
2017-10-08 23:56:51 +02:00
Actix http is licensed under the [Apache-2.0 license](http://opensource.org/licenses/APACHE-2.0).
2017-09-30 18:16:59 +02:00
2017-10-07 10:12:43 +02:00
## Features
* HTTP 1.1 and 1.0 support
* Streaming and pipelining support
2017-10-14 01:33:23 +02:00
* Keep-alive and slow requests support
2017-10-14 16:59:35 +02: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 18:16:59 +02:00
## Usage
2017-10-14 16:59:35 +02:00
To use `actix-web`, add this to your `Cargo.toml`:
2017-09-30 18:16:59 +02:00
```toml
[dependencies]
2017-10-14 16:59:35 +02:00
actix-web = { git = "https://github.com/fafhrd91/actix-web.git" }
2017-09-30 18:16:59 +02:00
```
2017-10-07 09:53:36 +02:00
## Example
```rust
extern crate actix;
2017-10-14 16:59:35 +02:00
extern crate actix_web;
2017-10-07 09:53:36 +02:00
extern crate futures;
use std::net;
use std::str::FromStr;
use actix::prelude::*;
2017-10-14 16:59:35 +02:00
use actix_web::*;
2017-10-07 09:53:36 +02:00
// Route
struct MyRoute;
impl Actor for MyRoute {
type Context = HttpContext<Self>;
}
impl Route for MyRoute {
type State = ();
2017-10-09 05:16:48 +02:00
fn request(req: HttpRequest, payload: Payload, ctx: &mut HttpContext<Self>) -> Reply<Self>
2017-10-07 09:53:36 +02:00
{
2017-10-14 01:33:23 +02:00
Reply::reply(httpcodes::HTTPOk)
2017-10-07 09:53:36 +02:00
}
}
fn main() {
2017-10-08 09:14:52 +02:00
let system = System::new("test");
2017-10-07 09:53:36 +02:00
// create routing map with `MyRoute` route
let mut routes = RoutingMap::default();
2017-10-08 06:48:00 +02:00
routes
.add_resource("/")
2017-10-07 09:53:36 +02: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");
}
```