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.

struct libtmux-rs latest

TestServer

One isolated tmux daemon and its descriptor-relative cleanup guard.

Source and package
Qualified name
libtmux::test::TestServer
Module
test
Package
libtmux
Source
crates/libtmux/src/test.rs
struct test.TestServer

Description#

This value owns its foreground daemon and socket-directory lifecycle and holds a no-start Server handle. The daemon uses a private explicit socket and an owned empty config, creating no initial session. Escaped Server clones share that handle's executor. TestServer::shutdown() closes the shared executor and reports graceful lifecycle and cleanup failures; Drop performs synchronous forced best-effort daemon and file cleanup whose failures cannot be observed.

Members8#

  • server method Return the no-start client handle for this isolated daemon.
  • shutdown method Stop the client executor and consume the daemon guard.
  • builder method Start a consuming isolated test-server builder.
  • daemon_pid method Return the retained foreground daemon PID.
  • daemon_state method Report whether the daemon is still running, and how it ended if not.
  • new method Start an isolated tmux server with the default builder settings.
  • session method Create a session on this fixture's server.
  • socket_path method Return this guard's explicit Unix socket path.

Guides#

Pages that discuss TestServer.

Esc

Type to search.

Reference previewOpen reference