diff options
author | Eliza Weisman <eliza@buoyant.io> | 2019-03-22 15:25:42 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-03-22 15:25:42 -0700 |
commit | 30330da11a56dfdd11bdbef50dba073a9edc36b2 (patch) | |
tree | bf4e8e90293a3c75a2bf5281572e1c01eceab3cb /examples/README.md | |
parent | 6e4945025cdc6f2b71d9b30aaa23c5517cca1504 (diff) |
chore: Fix examples not working with `cargo run` (#998)
* chore: Fix examples not working with `cargo run`
## Motivation
PR #991 moved the `tokio` crate to its own subdirectory, but did not
move the `examples` directory into `tokio/examples`. While attempting to
use the examples for testing another change, I noticed that #991 had
broken the ability to use `cargo run`, as the examples were no longer
considered part of a crate that cargo was aware of:
```
tokio on master [$] via 🦀v1.33.0 at ☸️ aks-eliza-dev
➜ cargo run --example chat
error: no example target named `chat`
Did you mean `echo`?
```
## Solution
This branch moves the examples into the `tokio` directory, so cargo is
now once again aware of them:
```
tokio on eliza/fix-examples [$] via 🦀v1.33.0 at ☸️ aks-eliza-dev
➜ cargo run --example chat
Compiling tokio-executor v0.1.7 (/Users/eliza/Code/tokio/tokio-executor)
Compiling tokio-reactor v0.1.9
Compiling tokio-threadpool v0.1.13
Compiling tokio-current-thread v0.1.6
Compiling tokio-timer v0.2.10
Compiling tokio-uds v0.2.5
Compiling tokio-udp v0.1.3
Compiling tokio-tcp v0.1.3
Compiling tokio-fs v0.1.6
Compiling tokio v0.1.18 (/Users/eliza/Code/tokio/tokio)
Finished dev [unoptimized + debuginfo] target(s) in 7.04s
Running `target/debug/examples/chat`
server running on localhost:6142
```
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Signed-off-by: Eliza Weisman <eliza@buoyant.io>
Diffstat (limited to 'examples/README.md')
-rw-r--r-- | examples/README.md | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/examples/README.md b/examples/README.md deleted file mode 100644 index 63634c82..00000000 --- a/examples/README.md +++ /dev/null @@ -1,60 +0,0 @@ -## Examples of how to use Tokio - -This directory contains a number of examples showcasing various capabilities of -the `tokio` crate. - -All examples can be executed with: - -``` -cargo run --example $name -``` - -A high level description of each example is: - -* [`hello_world`](hello_world.rs) - a tiny server that writes "hello world" to - all connected clients and then terminates the connection, should help see how - to create and initialize `tokio`. - -* [`echo`](echo.rs) - this is your standard TCP "echo server" which accepts - connections and then echos back any contents that are read from each connected - client. - -* [`print_each_packet`](print_each_packet.rs) - this server will create a TCP - listener, accept connections in a loop, and put down in the stdout everything - that's read off of each TCP connection. - -* [`echo-udp`](echo-udp.rs) - again your standard "echo server", except for UDP - instead of TCP. This will echo back any packets received to the original - sender. - -* [`connect`](connect.rs) - this is a `nc`-like clone which can be used to - interact with most other examples. The program creates a TCP connection or UDP - socket to sends all information read on stdin to the remote peer, displaying - any data received on stdout. Often quite useful when interacting with the - various other servers here! - -* [`chat`](chat.rs) - this spins up a local TCP server which will broadcast from - any connected client to all other connected clients. You can connect to this - in multiple terminals and use it to chat between the terminals. - -* [`chat-combinator`](chat-combinator.rs) - Similar to `chat`, but this uses a - much more functional programming approach using combinators. - -* [`proxy`](proxy.rs) - an example proxy server that will forward all connected - TCP clients to the remote address specified when starting the program. - -* [`tinyhttp`](tinyhttp.rs) - a tiny HTTP/1.1 server which doesn't support HTTP - request bodies showcasing running on multiple cores, working with futures and - spawning tasks, and finally framing a TCP connection to discrete - request/response objects. - -* [`tinydb`](tinydb.rs) - an in-memory database which shows sharing state - between all connected clients, notably the key/value store of this database. - -* [`udp-client`](udp-client.rs) - a simple `send_dgram`/`recv_dgram` example. - -* [`manual-runtime`](manual-runtime.rs) - manually composing a runtime. - -If you've got an example you'd like to see here, please feel free to open an -issue. Otherwise if you've got an example you'd like to add, please feel free -to make a PR! |