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

117 lines
3.7 KiB
Markdown
Raw Normal View History

2017-10-23 22:58:05 +00:00
# Actix web [![Build Status](https://travis-ci.org/actix/actix-web.svg?branch=master)](https://travis-ci.org/actix/actix-web) [![Build status](https://ci.appveyor.com/api/projects/status/kkdb4yce7qhm5w85/branch/master?svg=true)](https://ci.appveyor.com/project/fafhrd91/actix-web-hdy9d/branch/master) [![codecov](https://codecov.io/gh/actix/actix-web/branch/master/graph/badge.svg)](https://codecov.io/gh/actix/actix-web) [![crates.io](http://meritbadge.herokuapp.com/actix-web)](https://crates.io/crates/actix-web)
2017-09-30 16:16:59 +00:00
2017-10-23 22:58:05 +00:00
Asynchronous web framework for [Actix](https://github.com/actix/actix).
2017-09-30 16:16:59 +00:00
2017-10-23 22:58:05 +00:00
* [API Documentation (Development)](http://actix.github.io/actix-web/actix_web/)
* [API Documentation (Releases)](https://docs.rs/actix-web/)
2017-10-15 06:00:03 +00:00
* Cargo package: [actix-http](https://crates.io/crates/actix-web)
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-16 17:43:35 +00:00
Actix web 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-23 16:16:13 +00:00
* [WebSockets support](https://actix.github.io/actix-web/actix_web/ws/index.html)
2017-10-23 16:17:24 +00:00
* Configurable request routing
2017-10-21 09:08:07 +00:00
* Multipart streams
2017-10-23 16:17:24 +00:00
* Middlewares
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-23 18:48:06 +00:00
actix-web = "0.1"
2017-09-30 16:16:59 +00:00
```
2017-10-07 07:53:36 +00:00
## Example
2017-10-23 16:20:12 +00:00
* [Basic](https://github.com/actix/actix-web/tree/master/examples/basic.rs)
2017-10-23 18:48:06 +00:00
* [Stateful](https://github.com/actix/actix-web/tree/master/examples/state.rs)
2017-10-23 16:20:12 +00:00
* [Mulitpart streams](https://github.com/actix/actix-web/tree/master/examples/multipart)
* [Simple websocket session](https://github.com/actix/actix-web/tree/master/examples/websocket.rs)
2017-10-23 16:16:13 +00:00
* [Tcp/Websocket chat](https://github.com/actix/actix-web/tree/master/examples/websocket-chat)
2017-10-21 09:08:07 +00:00
2017-10-07 07:53:36 +00:00
```rust
extern crate actix;
2017-10-14 14:59:35 +00:00
extern crate actix_web;
2017-10-24 00:31:46 +00:00
extern crate env_logger;
2017-10-07 07:53:36 +00:00
2017-10-15 22:10:35 +00:00
use actix::*;
2017-10-14 14:59:35 +00:00
use actix_web::*;
2017-10-07 07:53:36 +00:00
2017-10-24 00:31:46 +00:00
struct MyWebSocket;
impl Actor for MyWebSocket {
type Context = HttpContext<Self>;
}
impl Route for MyWebSocket {
type State = ();
fn request(req: &mut HttpRequest,
payload: Payload, ctx: &mut HttpContext<Self>) -> RouteResult<Self>
{
let resp = ws::handshake(req)?;
ctx.start(resp);
ctx.add_stream(ws::WsStream::new(payload));
Reply::async(MyWebSocket)
}
}
impl StreamHandler<ws::Message> for MyWebSocket {
fn started(&mut self, ctx: &mut Self::Context) {
println!("WebSocket session openned");
}
fn finished(&mut self, ctx: &mut Self::Context) {
println!("WebSocket session closed");
}
}
impl Handler<ws::Message> for MyWebSocket {
fn handle(&mut self, msg: ws::Message, ctx: &mut HttpContext<Self>)
-> Response<Self, ws::Message>
{
println!("WS: {:?}", msg);
match msg {
ws::Message::Ping(msg) => ws::WsWriter::pong(ctx, msg),
ws::Message::Text(text) => ws::WsWriter::text(ctx, &text),
ws::Message::Binary(bin) => ws::WsWriter::binary(ctx, bin),
ws::Message::Closed | ws::Message::Error => {
ctx.stop();
}
_ => (),
}
Self::empty()
}
}
2017-10-07 07:53:36 +00:00
fn main() {
2017-10-24 00:31:46 +00:00
::std::env::set_var("RUST_LOG", "actix_web=info");
let _ = env_logger::init();
let sys = actix::System::new("ws-example");
2017-10-07 07:53:36 +00:00
2017-10-15 21:17:41 +00:00
HttpServer::new(
2017-10-23 16:16:13 +00:00
Application::default("/")
2017-10-24 00:31:46 +00:00
// enable logger
.middleware(Logger::new(None))
// websocket route
.resource("/ws/", |r| r.get::<MyWebSocket>())
.route_handler("/", StaticFiles::new("examples/static/", true)))
2017-10-15 21:53:03 +00:00
.serve::<_, ()>("127.0.0.1:8080").unwrap();
2017-10-07 07:53:36 +00:00
2017-10-24 00:31:46 +00:00
println!("Started http server: 127.0.0.1:8080");
2017-10-26 13:12:23 +00:00
Arbiter::system().send(msgs::SystemExit(0));
2017-10-24 00:31:46 +00:00
let _ = sys.run();
2017-10-07 07:53:36 +00:00
}
```