waos-dev-protocol 0.2.0

//! What `cargo waos` and a running WaOS say to each other: the messages of one run, how they
//! are framed on a stream, and the Unix socket on this machine that carries them.
//!
//! The connection is the run (the design's decision 29): `cargo waos run` connects, sends one
//! [`ToWaOS::Run`], and reads what comes back until the run ends. Closing the connection, by
//! Ctrl-C or the terminal closing, stops the program; a later run of the same id replaces it.
//! A run is the program its id names (decision 11 of the permissions proposal), with that
//! program's settings and folders, installed or not. `waos open` connects the same way and sends
//! one [`ToWaOS::Open`], files to open with the program an id names, which a WaOS answers once
//! (decision 3 of the opening proposal, until programs register what opens them). `cargo waos
//! screenshot`, `tap`, `type`, `key` and `scroll` connect the same way and send one
//! [`ToWaOS::Screenshot`] or [`ToWaOS::Input`] for the program an id names, which a WaOS answers
//! once, and only for a program a run of `cargo waos run` runs (the design's decision 60).
//! There is no stop message. On this machine the socket is in the user's own folder, so the
//! system's file permissions decide who may connect (decision 30); the network transport for
//! phones carries the same messages.
//!
//! The invariants a later editor will break:
//! - A variant's place among its enum's, and a field's place in its record, is its encoding:
//!   postcard writes a variant by its index and a record as its fields in order, with no names.
//!   Add at the end, and raise [`PROTOCOL`] for anything else.
//! - The first frame each way says [`PROTOCOL`], the number of the build that wrote it, outside
//!   the messages' encoding, and a side reads no message until the numbers agree: `cargo waos`
//!   and the WaOS it reaches are built from the same crate, and find out when they are not.
//!
//! On Windows the crate carries the messages and [`Connection`] but no transport: its named
//! pipe is step 11, and [`socket_path`] and [`Listener`] are not there.

mod connection;
mod messages;
#[cfg(unix)]
mod socket;

pub use connection::{Connection, MAX_FRAME_BYTES, PROTOCOL};
pub use messages::{FromWaOS, Input, OutputStream, RunEnd, ToWaOS, Unreached, WindowPicture};
#[cfg(unix)]
pub use socket::{Listener, socket_path};