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

ControlReply

One command's reply, framed between tmux's %begin and its terminator.

Source and package
Qualified name
ControlReply
Package
libtmux-swift
Source
Sources/LibTmux/ControlProtocol.swift
struct ControlReply : struct ControlReply

Description#

Framing is all this carries: whether the command succeeded is isError, and what it said is the body. Replies and notifications arrive on the same stream, so a reader gets both and has to expect either.

Members4#

  • init(number:lines:isError:) method
  • isError: let isError: Bool property tmux closed the block with %error rather than %end. The reason is in lines, the same place a successful reply's output is.
  • lines: let lines: [String] property What the command printed, one entry per line, with the block's own %begin and %end removed.
  • number: let number: Int property The number tmux stamped on this reply's block.

Inherited members1 member#

Reached through Equatable.!=(_:_:).

  • !=(_:_:) function inherited Returns a Boolean value indicating whether two values are not equal.
Esc

Type to search.

Reference previewOpen reference