README.md
1# p9 - Server implementation of the [9p] file system protocol
2
3This directory contains the protocol definition and a server implementation of
4the [9p] file system protocol.
5
6* [wire_format_derive] - A [procedural macro] that derives the serialization
7 and de-serialization implementation for a struct into the [9p] wire
8 format.
9* [src/protocol] - Defines all the messages used in the [9p] protocol. Also
10 implements serialization and de-serialization for some base types
11 (integers, strings, vectors) that form the foundation of all [9p]
12 messages. Wire format implementations for all other messages are derived
13 using the `wire_format_derive` macro.
14* [src/server.rs] - Implements a full [9p] server, carrying out file system
15 requests on behalf of clients.
16
17[9p]: http://man.cat-v.org/plan_9/5/intro
18[procedural macro]: https://doc.rust-lang.org/proc_macro/index.html
19[src/protocol]: src/protocol/
20[src/server.rs]: src/server.rs
21[wire_format_derive]: wire_format_derive/
22