Core LibraryAPI Reference

Choose documentation 3

latest

Current version

latest
English

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

class libtmux-java latest

LibTmuxException

Package io.github.libtmux.exception.LibTmuxException io.github.libtmux.exception

The root of every operational failure this library raises.

View as Markdown

Source and package
Module
io.github.libtmux.exception
Package
io.github.libtmux:libtmux
Source
libtmux/src/main/java/io/github/libtmux/exception/LibTmuxException.java
class io.github.libtmux.exception.LibTmuxException
classabstract [source]

Description#

Unchecked, because a tmux failure can arise from any call and forcing every caller to declare it would say nothing. Sealed, with every branch abstract, so matching on the permitted subtypes is exhaustive in Java, Kotlin and Scala alike.

A failure that came from a tmux command carries that command, its exit status when it has one, and the error lines tmux printed. Those lines, and the message that quotes them, name what tmux named — sessions, windows, panes and buffers included.

Discussed in Execution · Errors and exceptions

Members4 members#

Other members4 members#

  • command method The command that failed, when this failure came from one.
  • errorLines method The error lines tmux printed, in full. Empty when this failure has none.
  • exitCode method The process exit status, when the failure has one.
  • LibTmuxException method
Esc

Type to search.