FormatSubscription

struct FormatSubscription : struct FormatSubscription

struct [source] ¶

struct [source] ¶

struct FormatSubscription

Bases:

• Equatable
• Hashable
• Sendable
• SendableMetatype

A format tmux reports changes to, rather than being asked for.

refresh-client -B registers one against a control connection. tmux then evaluates the format about once a second and sends SubscriptionChange whenever the value differs from the last one it sent — so "has the foreground command changed?" costs no commands, no captures, and no scrollback at all.

Requires tmux 3.2 or later, which is this package's floor.

Discussed in Format-token fields

Members

• format property A tmux format, such as #{pane_current_command}.
• init(name:scope:format:) method
• name property What changes are reported under, and what ControlSession/stopWatching(_:) names.
• scope property
• Scope enum What tmux evaluates the format against.