Socket Type

Socket is a PathBuf newtype representing a Wayland socket path.

It exists as a distinct type rather than using PathBuf directly for two reasons:

1. Type safety - Functions that expect a Wayland socket can take &Socket instead of &Path, preventing accidental misuse with arbitrary paths.
2. Ergonomic trait implementations - AsRef<str> and Display make it easy to extract the socket name (e.g. wayland-0) for setting WAYLAND_DISPLAY in child environments.

Accessing the Path

The inner PathBuf is private. Use one of these methods to access it:

Serde

Socket implements Serialize and Deserialize, making it suitable for JSON/TOML configuration files.

Usage

#![allow(unused)]
fn main() {
use process_manager_socket::Socket;
use std::path::PathBuf;

// Construct from a path
let socket = Socket::from(PathBuf::from("/run/user/1000/wayland-0"));

// Display the full path
println!("{}", socket); // /run/user/1000/wayland-0

// Access as &Path via path() or Deref
let path = socket.path();
assert!(path.exists());

// Access as &str via AsRef
let socket_str: &str = socket.as_ref();
assert_eq!(socket_str, "/run/user/1000/wayland-0");
}

How It’s Used by ProcessManager

When a Socket is passed to ProcessConfig::socket(Some(socket)), the ProcessManager::start() method extracts the socket name (the last path component) and sets it as the WAYLAND_DISPLAY environment variable in the child process. This allows the child to connect to the correct Wayland display.

#![allow(unused)]
fn main() {
use process_manager::{ProcessConfig, ProcessManager, StdioConfig};
use process_manager_socket::Socket;
use std::path::PathBuf;

let socket = Socket::from(PathBuf::from("/run/user/1000/wayland-1"));

let config = ProcessConfig::builder()
    .command("gtk4-app".to_string())
    .socket(Some(socket))
    .stdout(StdioConfig::Null)
    .stderr(StdioConfig::Null)
    .build();

// The child process will have WAYLAND_DISPLAY=wayland-1
let id = manager.start("wayland-client", &config)?;
}