Core Library0.xAPI Reference

Choose documentation 3

Core Library API reference and guides

Home Guides Topics Concepts Examples API Reference

0.x Released; the API may change. Read more

MCP Tools for connected assistants

Home Guides Topics Examples Tools Prompts Resources API Reference

concept Working example; may change without notice. Read more

Workspace Manager Repeatable development environments

Home Guides Examples CLI Manual API Reference Configuration Internals

concept Working example; may change without notice. Read more

latest

Current version

English

Early release libtmux is released, and its APIs may still change between releases. This site's structure and URLs may change too.

Swift API

struct libtmux-swift latest

TmuxOption

One tmux option.

Base types DecodableEncodableEquatableHashableSendableSendableMetatype

Source and package

Qualified name: TmuxOption
Package: libtmux-swift
Source: Sources/LibTmux/Options.swift

struct TmuxOption : struct TmuxOption struct [source] ¶

Members5#

init(name:value:scope:) method
isUserOption: var isUserOption: Bool property A user option — one whose name begins with @. tmux never interprets these, so they are the safe place to keep your own state on a server.
name: let name: String property The option's name as tmux spells it, @-prefixed for a user option.
scope: let scope: OptionScope property The exact table this was read from.
value: let value: String property The value exactly as tmux printed it. tmux quotes values that need it, and unquoting is lossy without knowing the option's type, so the raw text is what the library keeps.

Inherited members2 members#

Reached through Equatable.!=(_:_:), Decodable.init(from:).

!=(_:_:) function inherited Returns a Boolean value indicating whether two values are not equal.
init(from:) method inherited Creates a new instance by decoding from the given decoder.

Reference preview