gorrosion_gtp/lib.rs
1//! Due to rustdoc lacking an [important feature][alias-doc],
2//! you will have to build the documentation including private items
3//! to be able to look up all the functions and traits
4//! that are defined by type aliases.
5//! If you are viewing this on [docs.rs][docs-rs],
6//! the private items should already be included.
7//!
8//! [alias-doc]: https://github.com/rust-lang/rust/issues/32077
9//! [docs-rs]: https://docs.rs/gorrosion-gtp
10
11#![feature(stmt_expr_attributes)]
12
13#![warn(missing_debug_implementations)]
14#![warn(missing_docs)]
15
16#[macro_use]
17extern crate nom;
18
19/// Despite its name,
20/// GTP feels like a binary protocol
21/// and we will treat it as such.
22/// Consequently, all “text” is a sequence of bytes.
23/// To emphasize that these bytes are not used for their numerical value
24/// but rather their property of “most generic kind of data”
25/// we will explicitly refer to them as `Byte` instead of `u8`.
26type Byte = u8;
27
28mod data;
29mod input;
30
31pub mod command;
32pub mod gtp_type;
33pub mod messages;