blob: c09ac5dcbe1f209fc1e76e76ae86a0c82dc9f2c1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
# futures-mio
Bindings to the `mio` crate implementing the `futures-io` and `futures`
abstractions.
[](https://travis-ci.org/alexcrichton/futures-rs)
[](https://ci.appveyor.com/project/alexcrichton/futures-rs)
[Documentation](http://alexcrichton.com/futures-rs/futures_mio)
## Usage
First, add this to your `Cargo.toml`:
```toml
[dependencies]
futures-mio = { git = "https://github.com/alexcrichton/futures-rs" }
```
Next, add this to your crate:
```rust
extern crate futures_mio;
```
## Examples
There are a few small examples showing off how to use this library:
* [echo.rs] - a simple TCP echo server
* [socks5.rs] - an implementation of a SOCKSv5 proxy server
[echo.rs]: https://github.com/alexcrichton/futures-rs/blob/master/futures-mio/src/bin/echo.rs
[socks5.rs]: https://github.com/alexcrichton/futures-rs/blob/master/futures-socks5/src/main.rs
## What is futures-mio?
This crate is a connection `futures`, a zero-cost implementation of futures in
Rust, and `mio`, a crate for zero-cost asynchronous I/O, and `futures-io`,
abstractions for I/O on top of the `futures` crate. The types and structures
implemented in `futures-mio` implement `Future` and `Stream` traits as
appropriate. For example connecting a TCP stream returns a `Future` resolving
to a TCP stream, and a TCP listener implements a stream of TCP streams
(accepted connections).
This crate also provides facilities such as:
* TCP streams
* TCP listeners
* UDP sockets
* Timeouts
* Data owned and local to the event loop
* An `Executor` implementation for a futures' `Task`
The intention of `futures-mio` is to provide a concrete implementation for
crates built on top of `futures-io`. For example you can easily turn a TCP
stream into a TLS/SSL stream with the [`futures-tls`] crate or use the
combinators to compose working with data on sockets.
[`futures-tls`]: http://alexcrichton.com/futures-rs/futures_tls
Check out the [documentation] for more information, and more coming here soon!
[documentation]: http://alexcrichton.com/futures-rs/futures_mio
# License
`futures-mio` is primarily distributed under the terms of both the MIT license
and the Apache License (Version 2.0), with portions covered by various BSD-like
licenses.
See LICENSE-APACHE, and LICENSE-MIT for details.
|
