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.

method libtmux-rs latest

ServerBuilder.socket_name

Select a named tmux socket, passed to tmux as -L.

Source and package
Qualified name
libtmux::server::builder::ServerBuilder::socket_name
Module
server.builder
Declared in
ServerBuilder
Package
libtmux
Source
crates/libtmux/src/server/builder.rs
#[must_use = "use the returned builder to retain the socket name" ] pub fn socket_name( mut self, name: impl Into<OsString> ) -> Self

Description#

Naming a socket here leaves LIBTMUX_SOCKET_PATH and LIBTMUX_SOCKET unread.

Examples#

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

Type to search.

Reference previewOpen reference