server.builder.ServerBuilder

struct server.builder.ServerBuilder

structoverload [source] ¶

structoverload [source] ¶

struct server.builder.ServerBuilder

A consuming builder for one inert Server handle.

Examples

use libtmux::{DispatchLimits, OutputLimits, Server};
use std::time::Duration;

// Naming a socket and a budget is the whole of the configuration; everything
// else is per-command.
let server = Server::builder()
    .socket_name("builder-example")
    .default_timeout(Duration::from_secs(5))
    .output_limits(OutputLimits::default().max_stdout_bytes(1024 * 1024))
    .dispatch_limits(DispatchLimits::default().max_in_flight(4))
    .build()?;

// Building does not start tmux, so this has not touched the machine yet.
let _ = server.identity();

Members

• build method Capture process context and construct an inert server handle.
• colors method Select tmux's 88- or 256-color compatibility mode.
• config_file method Select a tmux configuration file.
• control_client_limits method Bound how many control-mode clients may remain attached.
• default_timeout method Set the per-command dispatch deadline.
• dispatch_limits method Bound how many commands may run at once.
• output_limits method Bound how many bytes one command may read from tmux.
• socket_name method Select a named tmux socket.
• socket_path method Select an explicit tmux socket path.
• tmux_executable method Select the tmux executable without checking that it exists yet.