vs-protocol 0.1.13

Wire protocol for vibesurfer.
Documentation 
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

//! Wire-protocol encoder/decoder for vibesurfer.
//!
//! `vs-protocol` is the shared specification of the line-oriented wire
//! format documented in `docs/PROTOCOL.md` at the workspace root. The
//! daemon and the CLI both link this crate; the daemon emits, the CLI
//! parses (and vice-versa for requests).
//!
//! # Layout
//!
//! - [`codes`] — short codes ([`Role`], [`Op`], [`ErrorCode`],
//!   [`WarningCode`]) with `Display` and `FromStr` implementations.
//! - [`tree`] — in-memory [`Tree`] / [`Node`] / [`Ref`] and the
//!   indented full-tree wire format.
//! - [`delta`] — [`DeltaOp`] with encode/parse/[`apply`]/[`diff`].
//! - [`envelope`] — [`StateToken`], [`Warning`], [`Envelope`], and
//!   [`ResponseHead`].
//! - [`request`] — [`Request`] line.
//! - [`error::ParseError`] — every fallible parser returns this.

#![forbid(unsafe_code)]

pub mod codes;
pub mod delta;
pub mod envelope;
pub mod error;
pub mod request;
mod tokenize;
pub mod tree;

pub use codes::{ErrorCode, Op, Role, UnknownCode, WarningCode};
pub use delta::{apply, diff, DeltaOp};
pub use envelope::{Envelope, ResponseHead, StateToken, Warning};
pub use error::{ParseError, Result};
pub use request::Request;
pub use tree::{Node, Ref, Tree};

/// Returns the crate version (matches the workspace version).
#[must_use]
pub fn version() -> &'static str {
    env!("CARGO_PKG_VERSION")
}

#[cfg(test)]
mod tests {
    use super::version;

    #[test]
    fn version_matches_cargo_pkg_version() {
        assert_eq!(version(), env!("CARGO_PKG_VERSION"));
    }
}