Rust API

method libtmux-rs latest

Session.set_hook

Set one hook to a tmux command.

Source and package

Qualified name: libtmux::session::Session::set_hook
Module: session
Declared in: Session
Package: libtmux
Source: crates/libtmux/src/session/settings.rs
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptGo Java C# C++Swift Kotlin Scala OCaml F# Clojure

pub async fn set_hook( &self, name: &str, command: impl Into<OsString> ) -> Result<(), Error> method async [source] ¶

Description#

Hooks live in the same option tables, so a hook is an array option and Self::typed_option() reads it under an indexed name such as after-new-window[0].

Errors

Returns an error when tmux rejects the hook name or command.

Returns crate::Error::OptionScopeMismatch when tmux keeps the option in another of its tables.

Parameters

The tmux commands behind set_hook.

The C declarations in tmux that implement these commands.

Events that run tmux commands, with the scope each hook belongs to and where tmux fires it.

Bind a command to a session hook

Equivalents of Bind a command to a session hook in other languages
Language	Equivalent
Python	`libtmux.Session.set_hook`
Lua	`libtmux.Session:set_hook`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`session.Session.setHook`
Go	`tmux.Session.SetHook`
Java	reached through `Session.hooks`, whose `Hooks` carries the write
C#	reached through `Session.Hooks`, whose `TmuxHooks` carries the write
C++	`libtmux::Session::set_hook`
Swift	`Server.setHook(_:to:at:in:)`
OCaml	`Libtmux_unix.Client.set_hook`
Perl	`LibTmux::Server::set_hook` Use an explicit session target ID; command is an explicit native tmux command string.

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