Rust API

method libtmux-rs latest

Server.socket_name

Return the socket name tmux is given as -L, if any.

Source and package

Qualified name: libtmux::server::Server::socket_name
Module: server
Declared in: Server
Package: libtmux
Source: crates/libtmux/src/server.rs
Other languages: Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure

#[must_use] pub fn socket_name(&self) -> Option<&OsStr> method [source] ¶

Description#

It is None when a socket path was given, and when nothing chose a socket, so that tmux picks the server itself.

let server = libtmux::Server::builder().socket_name("example").build()?;
assert_eq!(server.socket_name(), Some(std::ffi::OsStr::new("example")));

The socket name this server addresses

Equivalents of The socket name this server addresses in other languages
Language	Equivalent
Python	`libtmux.Server.socket_name`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`server.Server.socketName`
Go	`Server.SocketPath` reports the resolved path instead
Java	no equivalent on `Server`
C#	no equivalent on `Server`
C++	`Server::at_socket_name` sets it rather than reading it
Swift	`Server.init(socketName:)` takes it rather than reporting it
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	socket_name is a constructor selector; no inferred name is added to captured handles.

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