Effects
What an operation does to tmux state.
Source and package
- Qualified name
-
libtmux::plan:: Effects - Module
- plan
- Package
- libtmux
- Source
- crates/libtmux/src/plan.rs
-
Description#
Carried as data rather than left implicit so a planner, a safety policy, and a documentation table all read the same answer.
Fields5#
| Name | Type | Description |
|---|---|---|
| creates | Option<Scope> | The scope of the object it creates, if it creates one. |
| destructive | bool | The operation removes an object. |
| idempotent | bool | Running it twice leaves what running it once leaves. |
| read_only | bool | The operation does not change tmux state. |
| reads_output | bool | It captures pane output, so its stdout is the answer. |