Pane.WaitUntilAsync
Waits until a condition holds over the rows the pane shows.
Source and package
- Module
- LibTmux
- Declared in
- Pane
- Package
- LibTmux
- Source
- src/LibTmux/Pane.Waiting.cs
- WaitUntilAsync ( condition : Func<IRead
Only <string>, bool> , timeout : TimeList Span , cancellationToken : CancellationToken ) Task<PaneWait >Result -
Description#
The condition is tested when the wait begins and again each time the pane prints or changes state, so a screen that is already right ends the wait at once as
PresentAtEntry. UnlikeWaitForTextAsync, it sees the whole screen, including rows a full-screen program redraws. A program that exits leaving a screen the condition accepts ends the wait asMatched, notPaneExited.- Parameters
-
-
condition ( Func<IRead
Only <string>, bool> ) – Judges the visible rows, top to bottom.List -
timeout ( Time
Span ) – How long to wait. -
cancellationToken ( Cancellation
Token ) – Stops the wait.
-
- Returns
-
How the wait ended.
- Raises
-
-
Argument
Out – The timeout is negative or longer than 49 days.Of Range Exception -
Tmux
Transport – Control observation failed.Exception -
Tmux
Object – tmux no longer has the pane when the wait begins.Not Found Exception
-