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

Server.prompt_history

The entries tmux remembers for one kind of prompt.

Source and package
Qualified name
libtmux::server::Server::prompt_history
Module
server
Declared in
Server
Package
libtmux
Source
crates/libtmux/src/server.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript GoJavaC# C++ Swift Kotlin Scala OCaml F# Clojure
pub async fn prompt_history( &self, kind: PromptKind ) -> Result<Vec<TmuxText>, Error>

Description#

tmux keeps a separate history per prompt kind, so the kind is required rather than defaulted: asking without one returns every kind at once, which is a different question.

Errors

Returns an error when the daemon is unsupported, cannot be reached, or refuses the listing.

Examples#

use libtmux::PromptKind;
let guard = libtmux::test::TestServer::new().await?;
let server = guard.server();
// A fresh server has answered no prompts.
assert!(server.prompt_history(PromptKind::Command).await?.is_empty());
guard.shutdown().await?;
Parameters

tmux command#

The tmux commands behind prompt_history.

tmux C API#

The C declarations in tmux that implement these commands.

In other ports#

Read what has been typed at command prompts

Equivalents of Read what has been typed at command prompts in other languages
Language Equivalent
Python libtmux.Server.show_prompt_history
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Server
Go tmux.Server.ShowPromptHistory
Java io.github.libtmux.Prompt.history
C# LibTmux.Server.GetPromptHistoryAsync
C++ no equivalent on Server
Swift no equivalent on Server
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