tmuxctl 0.1.0

A bidirectional tmux control-mode (tmux -C) client: typed notification stream, command reply correlation, pane-output decoding, and layout-tree parsing.
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
52
53
54
55
56
57
58
59
60
61

#![deny(warnings)]
//! `tmuxctl` — a bidirectional tmux **control-mode** (`tmux -C`) client.
//!
//! This crate is the wire between a Rust front-end and a tmux server: it spawns
//! `tmux -C`, parses the `%`-prefixed notification stream into typed
//! [`Notification`]s, correlates command replies by command-number, octal-decodes
//! pane output to raw bytes, and models tmux's layout tree ([`Layout`]).
//!
//! It is a **protocol layer only** — no terminal emulation, no rendering, no UI.
//! Those are the consumer's job (see [`hangar`]).
//!
//! The protocol contract lives in `docs/spec/overview.md`; a map of the tmux C
//! source that backs each wire detail lives in `docs/reference/tmux-source-map.md`.
//!
//! [`hangar`]: https://github.com/ace-rs/hangar
//!
//! # Status
//!
//! Early. The value types ([`PaneId`], [`Notification`], [`Layout`]), the pure
//! helpers ([`decode_output`], [`layout::checksum`], [`Layout::parse`]), and the
//! synchronous line [`Parser`] (framing + `%begin`/`%end` reply blocks) are in
//! place and tested. The async `Client` (spawn `tmux -C`, drive the parser over
//! tokio pipes, correlate replies to futures) is the next slice.

mod engine;
mod error;
mod ids;
mod notification;
mod output;

#[cfg(any(feature = "blocking", feature = "tokio", feature = "smol"))]
mod commands;
#[cfg(any(feature = "blocking", feature = "tokio", feature = "smol"))]
mod spawn;

#[cfg(feature = "blocking")]
mod blocking;
#[cfg(feature = "smol")]
mod smol_rt;
#[cfg(feature = "tokio")]
mod tokio_rt;

pub mod layout;
pub mod parser;

#[cfg(any(feature = "blocking", feature = "tokio", feature = "smol"))]
pub use spawn::SpawnOpts;

#[cfg(feature = "blocking")]
pub use blocking::Client;
pub use engine::{CommandError, CommandId, CommandOutput, Engine, Incoming};
pub use error::{Error, Result};
pub use ids::{PaneId, SessionId, WindowId};
pub use layout::Layout;
pub use notification::{Notification, WindowFlags};
pub use output::decode_output;
pub use parser::{Event, Parser, Reply};
#[cfg(feature = "smol")]
pub use smol_rt::SmolClient;
#[cfg(feature = "tokio")]
pub use tokio_rt::TokioClient;