Event
Something tmux reported that no command asked for.
Source and package
- Qualified name
-
libtmux::control:: Event - Module
- control
- Package
- libtmux
- Source
- crates/libtmux/src/control.rs
-
Description#
The variants cover every notification tmux publishes across the supported releases.
Event::Otherkeeps an unrecognized one rather than dropping it, because tmux adds notifications between releases; its name is the tmux notification without the leading%.Emission depends on the server release:
%config-error,%message,%paste-buffer-changedand%paste-buffer-deletedarrive from tmux 3.4, and the supported floor, 3.3a, emits none of them. Nothing else in the vocabulary is version-dependent.
Variants26#
| Case | Payload | Description |
|---|---|---|
| ClientDetached | { client: Tmux | A client detached from the server. |
| ClientSessionChanged | { client: Tmux | A client switched to a different session. |
| ConfigError | { message: Tmux | tmux could not read part of its configuration. |
| Continued | { pane: Pane | tmux resumed a pane it had paused. |
| Exit | { reason: Option<Tmux | The server is going away, so no further events will arrive. |
| ExtendedOutput | { pane: Pane | A pane produced output, and tmux said how far behind it is. |
| LayoutChanged | { window: Window | A window's panes were rearranged, added to, or removed from. |
| Message | { message: Tmux | A message tmux was asked to display, by display-message or a hook. |
| Other | { name: String, rest: Tmux | A notification this crate does not model. |
| Output | { pane: Pane | A pane produced output. |
| PaneModeChanged | { pane: Pane | A pane entered or left a mode, such as copy mode. |
| PasteBufferChanged | { name: Tmux | A paste buffer was created or replaced. |
| PasteBufferDeleted | { name: Tmux | A paste buffer was deleted. |
| Paused | { pane: Pane | tmux stopped sending a pane's output. |
| SessionChanged | { session: Session | The attached session changed. |
| SessionRenamed | { session: Session | A session was renamed. |
| SessionsChanged | No payload | A session was created or destroyed, so the session list is now wrong. |
| SessionWindowChanged | { session: Session | A session's active window changed. |
| SubscriptionChanged | { name: Tmux | A format this client subscribed to with refresh-client -B changed. |
| UnlinkedWindowAdded | { window: Window | A window appeared that the attached session does not link. |
| UnlinkedWindowClosed | { window: Window | A window the attached session does not link closed. |
| UnlinkedWindowRenamed | { window: Window | A window the attached session does not link was renamed. |
| WindowAdded | { window: Window | A window was linked into the attached session. |
| WindowClosed | { window: Window | A window in the attached session closed. |
| WindowPaneChanged | { window: Window | A window's active pane changed. |
| WindowRenamed | { window: Window | A window in the attached session was renamed. |
Members4#
- invalidates_listings method Report whether a listing taken before this event may now be wrong.
- may_have_added_a_pane method Report whether a pane may have appeared since the last look.
- pane method Return the pane this event is about, when it is about one.
- window method Return the window this event is about, when it is about one.