Core Library0.xAPI Reference

Choose documentation 3

latest

Current version

latest
English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

struct libtmux-go latest

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.

Source and package
Qualified name
tmux.OptionError
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/option_error.go
struct tmux.OptionError

Fields3#

OptionError fields
NameTypeDescription
Name string Name is the option or hook name, when available.
Result CommandResult Result contains the library-created error's exit code and no diagnostics.
Subcommand string Subcommand is the failed tmux option or hook subcommand.

Members2#

  • Error method Error implements error.
  • Unwrap method Unwrap makes OptionError compatible with ErrOption and its specific kinds.
Esc

Type to search.

Reference previewOpen reference