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

Go API

Go documentation

tmux.CommandError

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

View as Markdown

Module
tmux
Package
github.com/libtmux/libtmux-go/tmux
Source
tmux/command.go
struct tmux.CommandError
struct [source]
struct [source]
struct tmux.CommandError

CommandError reports a completed failed high-level tmux operation. It matches ErrCommand through errors.Is; callers can recover its fields with errors.As. Generic library operations retain an owned copy of the completed command and output so tmux diagnostics remain available. Operations whose primary payload may contain secrets return an exit-code-only result instead. Callers must treat retained argv and output as potentially sensitive.

5 declared, 0 inherited

Members

  • Is method Is reports ErrNoServer for a failure that means no tmux server answered — either the command never reached one, or the one it reached is gone — and ErrNotFound for one tmux refused because the object it named was absent.
  • Error method Error implements error.
  • Result attribute Result is the owned completed result, or an exit-code-only redacted result for a secret-bearing operation.
  • Subcommand attribute Subcommand is the failed tmux subcommand.
  • Unwrap method Unwrap makes CommandError compatible with ErrCommand.
Esc

Type to search.