TmuxError
Everything a tmux operation can fail with.
Source and package
- Qualified name
-
TmuxError - Package
- libtmux-swift
- Source
- Sources/LibTmux/TmuxError.swift
-
Description#
Server/run(_:)-(TmuxCommand)hands every tmux status back as aTmuxReply. Higher-level operations that promise a decoded value throw.commandFailed(command:exitCode:reason:)when tmux rejects that read.
Members18#
- cancelled: case cancelled constant The task was cancelled. A cancelled request never reports an empty listing — that would be indistinguishable from a server with no sessions.
- commandFailed(command:exitCode:reason:): case commandFailed(command: String, exit
Code : Int32, reason: String) constant tmux received a typed command but rejected it. - commandTooLarge(actualBytes:maximumBytes:): case commandTooLarge(actualBytes: Int, maximumBytes: Int) constant A direct tmux client cannot encode the command, so it was not submitted.
- connectionClosed: case connection
Closed constant A control-mode connection ended while a command was still waiting. - decodingFailed(_:): case decodingFailed(Format
Decoding ) constant tmux replied, but the reply did not match the requested projection.Error - foreignServerValue: case foreign
Server constant A value from another endpoint cannot target this server.Value - InvalidEndpoint: enum Invalid
Endpoint enum - invalidEndpoint(_:): case invalidEndpoint(Invalid
Endpoint ) constant The endpoint is not addressable. A UNIX socket path has a hard length limit far shorter than the filesystem's, and exceeding it fails at bind time rather than at construction. - invocationFailed(reason:): case invocationFailed(reason: String) constant No usable reply was obtained after submission. Unless a narrower error says otherwise, the action may have reached tmux.
- notificationBufferOverflow(limit:): case notificationBufferOverflow(limit: Int) constant An observer did not drain control notifications before its finite buffer filled. Earlier buffered notifications remain readable.
- outputContinuityLost: case output
Continuity constant A pane changed beyond the retained checkpoint while output was being watched, so new rows cannot be separated from rows already seen.Lost - outputLimitExceeded(perStreamBytes:): case outputLimitExceeded(perStreamBytes: Int) constant A reply exceeded its finite per-stream memory boundary.
- processLaunchFailed(reason:): case processLaunchFailed(reason: String) constant The tmux client process was never started, so the requested command cannot have reached a daemon.
- requestNotSubmitted: case request
Not constant A control connection closed before the command was enqueued. Retrying cannot duplicate the requested action because tmux never received it.Submitted - serverRestarted: case server
Restarted constant The reply arrived from a different server than the one the request was prepared against. - staleServerValue: case stale
Server constant A target no longer names the object or context the value described.Value - unsupportedTmuxVersion(reported:required:operation:): case unsupportedTmuxVersion(reported: String, required: String, operation: String) constant The tmux release behind the endpoint cannot serve the requested operation. Raised before the operation has any effect.
- unsupportedVersionMessage(reported:required:operation:) method What to tell a person whose tmux is older than the supported floor.
Inherited members2 members#
Reached through Equatable.!=(_:_:), Error.localizedDescription.
- !=(_:_:) function inherited Returns a Boolean value indicating whether two values are not equal.
- localizedDescription property inherited Retrieve the localized description for this error.
Guides#
Pages that discuss TmuxError.