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.

enum libtmux-rs latest

ControlModeErrorKind

Why a control-mode connection failed.

Source and package
Qualified name
libtmux::error::ControlModeErrorKind
Module
error
Package
libtmux
Source
crates/libtmux/src/error.rs
enum error.ControlModeErrorKind

Description#

The distinction matters to a caller: a connection that never opened is a setup problem, whereas one that closed mid-command may simply mean the session it was attached to has ended.

Variants9#

ControlModeErrorKind variants
CasePayloadDescription
DispatchTimedOut No payload A command's deadline elapsed before it was committed for writing.
BlockingCommand No payload The command would hold the connection's one command queue.
Closed No payload The connection closed before the command was answered.
InvalidSubscriptionName No payload A subscription name was empty, or contained a colon.
MissingPipes No payload tmux started without giving the crate the pipes it asked for.
TimedOut No payload The attach opening or a committed command exceeded its deadline.
Transport No payload The live control connection could not read from or write to its pipes.
Unread No payload The caller stopped reading events, so the connection could not reach this command's reply.
UnrepresentableCommand No payload The command contains an argument no control-mode line can carry.
Esc

Type to search.

Reference previewOpen reference