Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_snapshot:related/3

Traverse a complete captured relationship without I/O. To-many relations return lists; to-one relations return a row or known absence. The input row must belong to this snapshot. Unloaded relations and mismatched rows return tagged errors.

Source and package
Qualified name
tmux_snapshot:related/3
Declared in
tmux_snapshot
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_snapshot.erl
Other languages
Perlmethod PowerShellcmdlet Juliafunction Elixir Haskell Common Lispfunction PythonRuby Lua TypeScriptRustGoJavaC#C++SwiftKotlinScalaOCamlfunction F#function Clojurefunction
related/3 -spec related(atom(), tmux_model:row(), t()) -> {ok, [tmux_model:row()] | tmux_model:row() | none} | {error, map()}.
Parameters

Guides#

Pages that discuss related/3.

In other ports#

List a session's windows

Equivalents of List a session's windows in other languages
Language Equivalent
Python libtmux.Session.windows
Ruby LibTmux::Session#list_windows
PowerShell LibTmux\Get-TmuxWindow Use the -Session parameter set to acquire placements in one session.
Julia LibTmux.windows windows with a captured SessionSnapshot reads distinct physical windows in that session. Use windowlinks for placements.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:windows windows traverses a captured session. Repeated links preserve their physical-window multiplicity.
TypeScript session.Session.windows
Rust session.Session.windows
Go tmux.Session.Windows
Java io.github.libtmux.Session.windows
Clojure libtmux.data/windows Traverses one capture locally. It does not issue a list-windows command.
Kotlin io.github.libtmux.kotlin.Session.windows
Scala io.github.libtmux.scaladsl.Session.windows
C# LibTmux.Session.Windows
F# LibTmux.FSharp.Session.windows Builds a deferred window query from one LibTmux.Session and its server. Query.list acquires placements scoped to that session ID.
C++ libtmux::Session::windows
Swift Snapshot.windows(of:)
OCaml Libtmux.Session.windows Reads distinct captured global windows in this session. window_links preserves individual indexed placements.
Perl Traverse Session::window_links and resolve each link’s window, preserving explicit session placement and multiplicity.

No equivalent is recorded in Lua or Elixir.

List a window's panes

Equivalents of List a window's panes in other languages
Language Equivalent
Python libtmux.Window.panes
Ruby LibTmux::Window#list_panes
PowerShell LibTmux\Get-TmuxPane Use the -Window parameter set to acquire panes in one window.
Julia LibTmux.panes panes with a captured WindowSnapshot reads panes in that window; missing coverage is an error.
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp libtmux:panes panes traverses a captured window without contacting tmux.
TypeScript window.Window.panes
Rust window.Window.panes
Go tmux.Window.Panes
Java io.github.libtmux.Window.panes
Clojure libtmux.data/panes Traverses one capture locally. It does not issue a list-panes command.
Kotlin io.github.libtmux.kotlin.Window.panes
Scala io.github.libtmux.scaladsl.Window.panes
C# LibTmux.Window.Panes
F# LibTmux.FSharp.Window.panes Builds a deferred pane query from one LibTmux.Window and its server. Query.list acquires panes scoped to that window ID.
C++ libtmux::Window::panes
Swift Snapshot.panes(of:)
OCaml Libtmux.Window.panes Reads captured panes in one global window without I/O.
Perl LibTmux::Window::panes Reads this physical window’s captured panes without I/O.

No equivalent is recorded in Lua or Elixir.

Esc

Type to search.

Reference previewOpen reference