Swift API

method libtmux-swift latest

Server.session(_:)

The session with this id, or nil if the server has no such session.

Source and package

Qualified name: Server.session(_:)
Declared in: Server
Package: libtmux-swift
Source: Sources/LibTmux/Lookup.swift

session(id: SessionID) -> Session? method async [source] ¶

Examples#

Create a session and refresh its snapshot. Create a detached session with an editor window, add a logs window, then look up the session by its stable ID. The original Session still reports one window; the fresh snapshot reports two. Use Swift 6.2 or newer and tmux 3.3a or newer on Linux or macOS. In an empty directory, save this consumer package as Package.swift; SwiftPM fetches the library from release 0.1.1:

// swift-tools-version: 6.2
import PackageDescription

let package = Package(
    name: "ApiExample",
    platforms: [.macOS(.v13)],
    dependencies: [
        .package(url: "https://github.com/libtmux/libtmux-swift.git", from: "0.1.1")
    ],
    targets: [
        .executableTarget(
            name: "ApiExample",
            dependencies: [
                .product(name: "LibTmux", package: "libtmux-swift"),
                .product(name: "TmuxFixture", package: "libtmux-swift"),
            ],
            path: "Sources"
        )
    ]
)

Create a Sources directory and save this complete program as Sources/Example.swift. The withTmuxServer fixture owns a private tmux server and stops it after success or failure. Ordinary application code uses Server for its own socket; these examples use the fixture until their setup moves to ordinary server objects. View source

import Foundation
import LibTmux
import TmuxFixture

@main
struct ApiNewSession {
    static func main() async {
        do {
            try await withTmuxServer { @Sendable server in
                let session = try await server.newSession(named: "work", windowName: "editor")
                _ = try await server.newWindow(in: session, named: "logs")
                guard let refreshed = try await server.session(session.id) else {
                    throw ExampleError.sessionDisappeared
                }
                print("Created: \(session.name)")
                print("Original windows: \(session.windowCount)")
                print("Current windows: \(refreshed.windowCount)")
            }
        } catch {
            FileHandle.standardError.write(Data("Example failed: \(error)\n".utf8))
            exit(EXIT_FAILURE)
        }
    }

    enum ExampleError: Error {
        case sessionDisappeared
    }
}

Build and run the saved program. An operation or cleanup error produces a failing exit status. Set LIBTMUX_TMUX_BIN to an absolute executable path to select a tmux version:

$ swift run ApiExample

Expected output:

Created: work
Original windows: 1
Current windows: 2

Parameters

id (SessionID) #

Raises

TmuxError

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

Server.session(_:)

Examples#

Examples#

Related types#