Prerelease This site documents an alpha of libtmux. Its structure, URLs and APIs are subject to change.

TmuxShellCommand

Swift
  • Python Unavailable
  • Ruby Unavailable
  • Lua Unavailable
  • TypeScript Unavailable
  • Rust Unavailable
  • Go Unavailable
  • Java Unavailable
  • .NET Unavailable
  • C++ Unavailable
  • Swift

API reference · Markdown

struct TmuxShellCommand : struct TmuxShellCommand
struct [source]
struct [source]
struct TmuxShellCommand

A command to put in a pane, and whether to run it.

tmuxp writes most commands as a bare string, and that is what a string literal here means — type it and press enter. The long form, {cmd:, enter:}, exists to leave a command sitting in the pane unrun, which is why enter is modelled rather than dropped.

Members

init(unicodeScalarLiteral:)

init(unicodeScalarLiteral:) ( unicodeScalarLiteral : Self.ExtendedGraphemeClusterLiteralType )
method
method
init(unicodeScalarLiteral:)

Inherited from ExpressibleByExtendedGraphemeClusterLiteral.init(unicodeScalarLiteral:)

init(extendedGraphemeClusterLiteral:)

init(extendedGraphemeClusterLiteral:) ( extendedGraphemeClusterLiteral : Self.StringLiteralType )
method
method
init(extendedGraphemeClusterLiteral:)

Inherited from ExpressibleByStringLiteral.init(extendedGraphemeClusterLiteral:)

!=(_:_:)

!=(_:_:) ( lhs : Self , rhs : Self ) → Bool
functionstatic
functionstatic
!=(_:_:)

Inherited from Equatable.!=(_:_:)

Returns a Boolean value indicating whether two values are not equal.

Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

  • Parameters:
    • lhs: A value to compare.
    • rhs: Another value to compare.

command

command : let command: String
property [source]
property [source]
command

The line to type into the pane.

enter

enter : let enter: Bool
property [source]
property [source]
enter

Whether to press enter after typing it. False leaves the line sitting at the prompt, ready but not run.

init(_:enter:)

init(_:enter:) ( command : String , enter : Bool )
method [source]
method [source]
init(_:enter:)

init(stringLiteral:)

init(stringLiteral:) ( stringLiteral : String )
method [source]
method [source]
init(stringLiteral:)

Creates an instance initialized to the given string value.

  • Parameter value: The value of the new instance.

init(from:)

init(from:) ( from : any Decoder )
method [source]
method [source]
init(from:)

Creates a new instance by decoding from the given decoder.

This initializer throws an error if reading from the decoder fails, or if the data read is corrupted or otherwise invalid.

  • Parameter decoder: The decoder to read data from.

encode(to:)

encode(to:) ( to : any Encoder ) → ()
method [source]
method [source]
encode(to:)

Written back the way it was most likely written: a bare string unless enter carries information a string cannot.

Esc

Type to search.