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.

struct libtmux-go latest

ControlCommandResult

ControlCommandResult is one completed control-mode command frame. A failed tmux command remains result data through Failed; local, protocol, transport, and context failures are returned separately by Connection.Call, ControlClient.Cmd, and ControlClient.Call. All slices are owned by the caller.

Source and package
Qualified name
tmux.ControlCommandResult
Package
tmux
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/control_protocol.go
struct tmux.ControlCommandResult

Fields6#

ControlCommandResult fields
NameTypeDescription
Command []string Command is the safely encoded command's original argument vector.
Failed bool Failed reports whether tmux closed the frame with %error instead of %end.
Flags int Flags contains tmux's frame flags.
Number uint64 Number is tmux's command number for the frame. tmux counts commands the server processed rather than commands this client sent, so a command from any other client advances it too and the gap between two frames is not a count of this client's work.
RawStdout []byte RawStdout contains exact frame payload bytes, including each line's LF.
Timestamp int64 Timestamp is tmux's frame timestamp in Unix seconds.
Esc

Type to search.

Reference previewOpen reference