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

Window.display

Show a message on the clients viewing this window.

Source and package
Qualified name
libtmux::window::Window::display
Module
window
Declared in
Window
Package
libtmux
Source
crates/libtmux/src/window.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Go Java C#C++ Swift Kotlin Scala OCaml F# Clojure
pub async fn display(&self, message: &str) -> Result< (), Error >

Description#

The showing half of tmux's display-message. Nothing is returned because nothing is read: use Self::format() to get text back. Succeeds when nobody is watching, having shown it to nobody. Like Self::format(), this interprets the message as a tmux format; command and recursive formats can run shell commands.

Errors

Returns an error when tmux cannot be reached or refuses the message.

Parameters

tmux command#

The tmux commands behind display.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Show a message on the client viewing a window

Equivalents of Show a message on the client viewing a window in other languages
Language Equivalent
Python libtmux.Window.display_message
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Window
Go tmux.Window.DisplayMessage
Java no equivalent on Window
C# LibTmux.Window.DisplayMessageAsync
C++ libtmux::Window::show_message
Swift no equivalent on Window
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 Ruby, Lua, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.

Esc

Type to search.

Reference previewOpen reference