Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

struct libtmux-rs latest

ControlMode

One control-mode connection to a tmux server.

Source and package
Qualified name
libtmux::control::ControlMode
Module
control
Package
libtmux
Source
crates/libtmux/src/control.rs
struct control.ControlMode

Description#

Sending and receiving are separate handles, reachable through split(). That is not decoration: the point of control mode is to act on what you observe, and a single object would need &mut for both, so a task awaiting an event could never send the command that event implies.

Members7#

Common operations1#

  • attach method Attach to a session in control mode.

Other members6#

  • attach_with_limits method Attach with explicit frame budgets.
  • next_event method Return the next notification or terminal error, then None.
  • reply_timeout method Set how long a command waits for its result block.
  • send method Send one command and wait for its result block.
  • shutdown method Close the connection and report how it ended.
  • split method Separate the two halves so they can be used at the same time.

Guides#

Pages that discuss ControlMode.

Esc

Type to search.

Reference previewOpen reference