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.

class libtmux-dotnet latest

TmuxUnsupportedOnReleaseException

Reports a command or feature that is unsafe or unavailable on the running tmux release.

Source and package
Qualified name
LibTmux.TmuxUnsupportedOnReleaseException
Namespace
LibTmux
Package
LibTmux
Source
src/LibTmux/Exceptions/TmuxUnsupportedOnReleaseException.cs
class LibTmux.TmuxUnsupportedOnReleaseException

Description#

Every refusal for a release reason raises this type or a subclass, so one catch block covers a release that lacks a feature, a release that crashes on a form, and a release that rejects an input other releases accept. TmuxVersionTooLowException is the subclass for a plain release floor. A typed call that leaves a flag out on an older release, such as Server.RefreshClientAsync dropping -l, skips the flag and raises nothing.

The library decides a refusal before anything is sent, so the exceptions it raises carry TmuxDispatchState.NotDispatched in Dispatch, and sending the command again on the same release repeats the refusal. An input that is invalid on every release is not this type; it is an ArgumentException.

Properties4#

TmuxUnsupportedOnReleaseException properties
NameTypeDescription
ActualVersion TmuxVersion Gets the running tmux release.
CapabilityId string? Gets the capability or workaround id in capabilities.json, or null when none covers the refusal.
Command string? Gets the refused tmux command, or null when the refusal is not about one command.
SafeReleases string Gets the releases where the command is safe, such as 3.4 or newer.

Members1#

Esc

Type to search.

Reference previewOpen reference