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

TestServerBuilder.start

Start the isolated foreground tmux daemon.

Source and package
Qualified name
libtmux::test::TestServerBuilder::start
Module
test
Declared in
TestServerBuilder
Package
libtmux
Source
crates/libtmux/src/test.rs
pub async fn start(self) -> Result< TestServer, TestServerError >

Description#

Errors

Returns a source-less test-support error when setup, startup, readiness, or rollback cleanup cannot be completed safely.

Startup creates a private explicit socket and owned empty config without creating an initial session.

Cancel safety

Nothing is left behind, on a best-effort basis: a start dropped before it returns the guard forces its daemon down and removes its files at once, and a failure doing so goes unreported.

Examples#

let guard = libtmux::test::TestServer::builder().start().await?;
guard.shutdown().await?;
Esc

Type to search.

Reference previewOpen reference