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.

enum libtmux-rs latest

Subscription

What a subscription watches.

Source and package
Qualified name
libtmux::control::Subscription
Module
control
Package
libtmux
Source
crates/libtmux/src/control.rs
enum control.Subscription

Description#

tmux reads this from the shape of the argument rather than from a keyword: % introduces a pane, @ a window, * stands for every one of them, and anything else names the session the control client is attached to. The session case is therefore spelled as nothing at all, which is the canonical form rather than a special case.

Examples#

use libtmux::control::Subscription;
assert_eq!(Subscription::AllPanes.to_string(), "%*");
assert_eq!(Subscription::AllWindows.to_string(), "@*");
// The session the connection is attached to, named by naming nothing.
assert_eq!(Subscription::Session.to_string(), "");

Variants5#

Subscription variants
CasePayloadDescription
AllPanes No payload Every pane in the attached session.
AllWindows No payload Every window in the attached session.
Pane (PaneId) One pane.
Session No payload The session this connection is attached to.
Window (WindowId) One window.
Esc

Type to search.

Reference previewOpen reference