tmux.OptionError

struct tmux.OptionError

struct [source] ¶

struct [source] ¶

struct tmux.OptionError

OptionError reports a completed high-level option or hook failure. It matches ErrOption and a specific option sentinel through errors.Is; callers can recover its fields with errors.As. Library-created errors retain only Result.ExitCode. Error never renders command output because option values and hook commands may be secret; callers may construct exported values with other contents.

Members

• Error method Error implements error.
• Name attribute Name is the option or hook name, when available.
• Result attribute Result contains the library-created error's exit code and no diagnostics.
• Subcommand attribute Subcommand is the failed tmux option or hook subcommand.
• Unwrap method Unwrap makes OptionError compatible with ErrOption and its specific kinds.