boitalettres/doc/draft.md

33 lines
882 B
Markdown
Raw Normal View History

2022-05-10 15:42:56 +00:00
# Just Enough Doc
## Run `simple` example
2022-05-10 15:42:56 +00:00
This example is meant to show basic service-based IMAP server with boitalettres library.
- [Source code](../examples/simple.rs)
```shell
$ cargo run --example simple
```
2022-05-19 10:45:03 +00:00
If you want to trace this `simple` example with the [`tokio-console`](https://github.com/tokio-rs/console/tree/main/tokio-console) utility, run:
```shell
$ RUSTFLAGS="tokio_unstable" cargo run --example simple --features "tokio/tracing"
```
2022-05-10 15:42:56 +00:00
- [Basic python testing script](../scripts/test_imap.py)
```shell
$ python scripts/test_imap.py
```
## Notes
- The library use the `tracing` library for logging, a basic setup is shown in the `simple` example with the `tracing-subscriber` crate.
2022-05-10 15:42:56 +00:00
## References
- [`imap-codec`](https://docs.rs/imap-codec): IMAP protocol model+encoder/decoder
- [`tower`](https://docs.rs/tower): Service-based request handling library