libtmux 0.1.0

Async typed tmux client and object model
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

{
  "schemaVersion": 1,
  "language": "rust",
  "nativeInventory": "crates/libtmux/docs/public-api.txt",
  "setupFiles": [
    {
      "sourceFile": "crates/libtmux/examples/api/consumer.toml",
      "name": "Cargo.toml"
    },
    {
      "sourceFile": "rust-toolchain.toml",
      "name": "rust-toolchain.toml"
    }
  ],
  "programFileName": "src/main.rs",
  "runCommand": "cargo run --quiet",
  "examples": [
    {
      "id": "rust-construction",
      "title": "Construct a private server",
      "description": "Construct a handle without starting tmux, then create a session on its own socket.",
      "sourceFile": "crates/libtmux/examples/api_construction.rs",
      "cargoExample": "api_construction",
      "targets": [
        "libtmux::Server",
        "libtmux::Server::builder",
        "libtmux::ServerBuilder::socket_path",
        "libtmux::ServerBuilder::config_file",
        "libtmux::ServerBuilder::default_timeout",
        "libtmux::ServerBuilder::build"
      ],
      "expectedOutput": "construction: private daemon started by new_session"
    },
    {
      "id": "rust-listings",
      "title": "List sessions, windows and panes",
      "description": "Read each collection and its relations, then inspect a hierarchy snapshot.",
      "sourceFile": "crates/libtmux/examples/api_listings.rs",
      "cargoExample": "api_listings",
      "targets": [
        "libtmux::Server::sessions",
        "libtmux::Server::windows",
        "libtmux::Server::panes",
        "libtmux::Server::hierarchy",
        "libtmux::Session::windows",
        "libtmux::Session::panes",
        "libtmux::Window::panes"
      ],
      "expectedOutput": "listings: 1 session, 2 windows, 2 panes"
    },
    {
      "id": "rust-creation",
      "title": "Create windows and split panes",
      "description": "Create a session and a second window, then split from a window and from a pane.",
      "sourceFile": "crates/libtmux/examples/api_creation.rs",
      "cargoExample": "api_creation",
      "targets": [
        "libtmux::Server::new_session",
        "libtmux::NewSessionOptions",
        "libtmux::Session::new_window",
        "libtmux::NewWindowOptions",
        "libtmux::Window::split",
        "libtmux::Pane::split",
        "libtmux::SplitOptions"
      ],
      "expectedOutput": "creation: 2 windows, 4 panes"
    },
    {
      "id": "rust-query",
      "title": "Filter snapshots with typed fields",
      "description": "Match a session name prefix without changing the source snapshot.",
      "sourceFile": "crates/libtmux/examples/api_query.rs",
      "cargoExample": "api_query",
      "targets": [
        "libtmux::query::Filterable",
        "libtmux::query::QueryIteratorExt::matching"
      ],
      "expectedOutput": "query: prod-api"
    },
    {
      "id": "rust-cardinality",
      "title": "Handle missing and ambiguous matches",
      "description": "Compare exactly_one and one_or_none for no match, one match and multiple matches.",
      "sourceFile": "crates/libtmux/examples/api_cardinality.rs",
      "cargoExample": "api_cardinality",
      "targets": [
        "libtmux::query::QueryIteratorExt::exactly_one",
        "libtmux::query::QueryIteratorExt::one_or_none",
        "libtmux::query::ExactlyOneError",
        "libtmux::query::MultipleItemsError"
      ],
      "expectedOutput": "cardinality: none, one, multiple"
    },
    {
      "id": "rust-input",
      "title": "Send literal text and named keys",
      "description": "Wait for a shell prompt, send literal text without Enter, then submit a named Enter key.",
      "sourceFile": "crates/libtmux/examples/api_input.rs",
      "cargoExample": "api_input",
      "targets": [
        "libtmux::Pane::send_keys",
        "libtmux::Pane::send_key_names"
      ],
      "expectedOutput": "input: C-c is text"
    },
    {
      "id": "rust-capture",
      "title": "Capture complete output lines",
      "description": "Submit a shell command atomically and wait for whole output lines within a deadline.",
      "sourceFile": "crates/libtmux/examples/api_capture.rs",
      "cargoExample": "api_capture",
      "targets": [
        "libtmux::Pane::send_line",
        "libtmux::Pane::capture",
        "libtmux::Pane::wait_for_text"
      ],
      "expectedOutput": "capture: first line, second line"
    }
  ]
}