tmux_interface

Description

tmux_interface is a Rust language library for communication with TMUX via CLI.

Usage

1. Add a dependency in your Cargo.toml

   [dependencies] tmux_interface = "^0.1.0"

2. Add extern crate and use in your source file

   extern crate tmux_interface;

3. Use it's functions ``` use tmux_interface::{AttachSession, NewSession, TmuxInterface};

   let mut tmux = TmuxInterface::new(); let newsession = NewSession { detached: Some(true), sessionname: Some("sessionname"), ..Default::default() }; tmux.newsession(Some(&newsession)).unwrap(); let attachsession = AttachSession { targetsession: Some("sessionname"), ..Default::default() }; tmux.attachsession(Some(&attach)).unwrap(); tmux.killsession(None, None, Some("session_name")).unwrap(); ```

Misc

• Versions below 0.1.0 are first public releases, mostly for development and testing purposes. Do not use them in your Projects.

• Used in mosaic - tmux manager

Testing

The library was tested under following conditions.

Tmux: - tmux 3.0a

Rust: - stable (manually, Travis CI) - beta (Travis CI) - nightly (Travis CI)

OS: - Debian 11 Bullseye, x64 (manually) - Ubuntu 16.04 Xenial Xerus, x64 (Travis CI) - MacOS 10.13.6 High Sierra, x64 (Travis CI)

Directory Structure

• src/ - crate sources

  1. Common:

     • tmux_interface.rs - common functions
     • error.rs - error propagating functions
     • lib.rs - main library file

  2. TMUX functions (structure similar to TMUX manual):

     • clients_and_sessions.rs
     • windows_and_panes.rs
     • key_bindings.rs
     • options.rs
     • hooks.rs
     • global_and_session_environment.rs
     • status_line.rs
     • buffers.rs
     • miscellaneous.rs

  3. Unit tests for functions and their parts:

     • tmux_interface_tests.rs

  4. Parsing functions:

     • sessions.rs - parse a session list
     • session.rs - parse a session
     • session_stack.rs - session stack
     • windows.rs - parse a windows list
     • window.rs - parse a window
     • window_flag.rs - window flag
     • panes.rs - parse a panes list
     • pane.rs - parse a pane
     • pane_tabs.rs - pane tabs
     • tmux_option.rs - parse an option
     • version.rs - parse version response
     • layout_cell.rs - parse layout cell string
     • layout_checksum.rs - calculate layout checksum
     • layout.rs - parse layot tree string

  5. Unit tests for parsing functions:

     • sessions_tests.rs
     • session_tests.rs
     • windows_tests.rs
     • window_tests.rs
     • panes_tests.rs
     • pane_tests.rs
     • tmux_option_tests.rs
     • version_tests.rs
     • layout_cell_tests.rs
     • layout_checksum_tests.rs
     • layout_tests.rs

• tests/ - crate integration tests (multiple functions):

  • issue1.rs - issue #1 tests
  • sessions_tests.rs - sessions tests
  • windows_tests.rs - windows tests
  • panes_tests.rs - panes tests
  • tmux_error_mock.sh - bash script for testing of tmux error handling functions
  • tmux_interface.rs
  • tmux_mock.sh - bash script can be used instead of tmux binary, for simple logging (sniffing) intercommmunication between library functions and tmux
  • tmux_test.sh - bash script for output testing of tmux functions

• Cargo.toml - crate configuration (File Format)

• CHANGELOG.md - version history
• clippy.toml - Clippy configuration file (Clippy)
• .editorconfig - consistent coding style configuration (File Format)
• LICENSE.md - license text
• README.md - common information (this file)
• ROADMAP.md - future goals, wishlist, ideas
• rustfmt.toml - rustfmt configuration file (rustfmt)
• rust-toolchain - rustup toolchain configuration file (rustup)
• .travis.yml - travis CI configuration (File Format)

Contributing

If you are interested in this project and you have:

• a bug report
• any feature suggestion
• nice code contribution
• an improvment idea
• ...

You are allways welcome, please feel free to use following links to contact me and/or to contribute to the project:

• Write E-Mail
• Open issue
• Send pull request

License

tmux_interface is licensed under the MIT license. Please read the license file in this repository for more information.