Core LibraryalphaAPI 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-cxx latest

Server.wait_for_text

Wait until the pane target names produces wanted.

Source and package
Qualified name
libtmux::Server::wait_for_text
Namespace
libtmux
Declared in
Server
Package
libtmux-cxx
Source
include/libtmux/server.hpp
[[C++ nodiscard attributeAsks the compiler to warn when a result is discarded. An explicit cast to void acknowledges that the result is intentionally ignored.Language documentation]] expected<WaitResult, CommandFailure> wait_for_text(std::string_view target, std::string_view wanted, const WaitOptions& options = {}) const;

Description#

For a caller holding a target rather than a Pane — Pane::wait_for_text() is the same wait without the lookup. One deadline covers both: a target that will not resolve cannot spend the whole budget and leave nothing for waiting, and WaitPath::pane_lookup says that is what happened.

tmux command#

The tmux commands behind wait_for_text.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference