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.

Go API

method libtmux-go latest

Window.Swap

Swap exchanges the receiver and Target exact winlinks. Their stable WindowIDs move to the opposite session-and-index views; a WindowID alone does not identify either endpoint. Unless Detach is set, tmux may change the affected sessions' current-window selection; this is not a global client-focus guarantee.

Source and package
Qualified name
tmux.Window.Swap
Package
tmux
Declared in
Window
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/window_pane_swap.go
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptRust Java C#C++Swift Kotlin Scala OCaml F# Clojure

Description#

Swap returns both freshly materialized exact endpoint views. If exact refresh fails after the command, it returns a predicted WindowSwapResult carrying both stable IDs and post-swap session/index contexts with the error. Earlier failures return zero; transport errors are delivery-ambiguous.

tmux command#

The tmux commands behind Swap.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Exchange two windows

Equivalents of Exchange two windows in other languages
Language Equivalent
Python libtmux.Window.swap
Lua libtmux.WindowLink:swap
Erlang tmux_window_link:swap/3
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript window.Window.swapWith
Rust window.Window.swap_with
Java no equivalent on Window
C# LibTmux.Window.SwapAsync
C++ libtmux::Window::swap_with
Swift Server.swap(_:with:)
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Ruby, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference