Rust API

method libtmux-rs latest

Server.source_file

Load a tmux configuration file into this server.

Source and package

Qualified name: libtmux::server::Server::source_file
Module: server
Declared in: Server
Package: libtmux
Source: crates/libtmux/src/server.rs
Other languages: Perl Erlangfunction PowerShell Julia Elixir Haskell Common Lisp PythonRuby Lua TypeScriptGoJavaC#C++Swift Kotlin Scala OCaml F# Clojure

pub async fn source_file( &self, path: impl Into<PathBuf> ) -> Result<(), Error> method async [source] ¶

Description#

Errors

Returns an error when tmux cannot read the file or a command in it fails.

Parameters

The tmux commands behind source_file.

The C declarations in tmux that implement these commands.

Load a tmux configuration file

Equivalents of Load a tmux configuration file in other languages
Language	Equivalent
Python	`libtmux.Server.source_file`
Ruby	`LibTmux::Server#source_file`
Erlang	`tmux_command:source_file/2` Builds a trusted command value. Execute it explicitly with `tmux_server:command/3`.
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`server.Server.sourceFile`
Go	`tmux.Server.SourceFile`
Java	`io.github.libtmux.Server.sourceFile`
C#	`LibTmux.Server.SourceFileAsync`
C++	`libtmux::Server::source_file`
Swift	`Server.sourceFile(_:)`
OCaml	No direct public OCaml equivalent is recorded for this operation.
Perl	No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

No equivalent is recorded in Lua, PowerShell, Julia, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.