Elixir API

struct libtmux-elixir latest

Session

An immutable session observation with explicit actions. Attachment retains tmux's client count.

Source and package

Qualified name: LibTmux.Session
Module: LibTmux
Package: libtmux
Source: lib/libtmux/entities.ex
Other languages: PowerShellcmdlet Juliastruct PythonRubyLuaTypeScriptRustGoJavaC#C++SwiftKotlinScalaF#module

struct LibTmux.Session struct libtmux [source] ¶

In other ports A tmux session

PowerShell
LibTmux\Get-TmuxSession
This cmdlet reads and returns shared .NET LibTmux.Session objects. Child windows and panes require further acquisition.
Julia
LibTmux.SessionSnapshot
SessionSnapshot holds captured session data. Actions use its SessionRef , a typed identity bound to an observed daemon generation.
Python
libtmux.Session
Ruby
LibTmux::Session
Lua
libtmux.Session
TypeScript
session.Session
Rust
session.Session
Go
tmux.Session
Java
io.github.libtmux.Session
C#
LibTmux.Session
C++
libtmux::Session
Swift
Session
Kotlin
io.github.libtmux.kotlin.Session
Scala
io.github.libtmux.scaladsl.Session
F#
LibTmux.FSharp.Session
This F# module builds deferred child queries from a shared .NET LibTmux.Session and its server association. Query.list acquires their results from tmux.

Members11#

windows/2 function Returns a plain list of captured physical windows in first-link order.
panes/2 function Returns a plain list of captured physical panes in numeric pane-ID order.

id: String.t() property Required: building the struct without this key is an error.
name: LibTmux.Schema.observed(String.t()) property
attached: LibTmux.Schema.observed(boolean()) property
active_window/2 function Returns the captured active physical window, or nil when none is active.
attached_count: LibTmux.Schema.observed(non_neg_integer()) property

rename!/4 function Returns :ok when rename/4 completes; raises API errors or LibTmux.Action.CompletionError otherwise.
rename/4 function Renames an exact session through the selected transport; returns an action result.
server_instance: String.t() property Required: building the struct without this key is an error.
t/0: t() :: %LibTmux.Session{ attached: LibTmux.Schema.observed(boolean()), attached_count: LibTmux.Schema.observed(non_neg_integer()), id: String.t(), name: LibTmux.Schema.observed(String.t()), server_instance: String.t() } typealias A session with explicit field coverage and an attachment count separate from its Boolean projection.