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-dotnet latest

LibTmuxException

Namespace LibTmux.LibTmuxException LibTmux

Provides the base exception for remote tmux failures.

View as Markdown

Source and package
Module
LibTmux
Package
LibTmux
Source
src/LibTmux/Exceptions/LibTmuxException.cs
class LibTmux.LibTmuxException
class [source]

Description#

Every failure carries a Dispatch state, so the question a caller asks in a catch block — is it safe to run this again? — is answered on the exception rather than inferred from its type.

Examples#

catch (LibTmuxException error) when (error.Dispatch == TmuxDispatchState.NotDispatched)
{
// tmux never saw it, so sending it again repeats nothing.
}

Discussed in Errors and exceptions

Members2 members#

Common operations1 member#

  • Dispatch property Gets whether the command reached tmux, and so whether a retry is safe.

Other members1 member#

  • LibTmuxException method Initializes a LibTmux exception whose dispatch state is unknown.
Esc

Type to search.