Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

plan.Effects

Rust
  • Python Unavailable
  • Ruby Unavailable
  • Lua Unavailable
  • TypeScript Unavailable
  • Rust
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift Unavailable

View as Markdown

Module
plan
Package
libtmux
Source
crates/libtmux/src/plan.rs
struct plan.Effects
structoverload [source]
structoverload [source]
struct plan.Effects

What an operation does to tmux state.

Carried as data rather than left implicit so a planner, a safety policy, and a documentation table all read the same answer.

5 declared, 0 inherited

Members

  • creates attribute The scope of the object it creates, if it creates one.
  • destructive attribute The operation removes an object.
  • idempotent attribute Running it twice leaves what running it once leaves.
  • read_only attribute The operation does not change tmux state.
  • reads_output attribute It captures pane output, so its stdout is the answer.
Esc

Type to search.