Pane.WaitForText

Description#

The wait is level-triggered. Text already on screen matches at once, with PaneTextWait.MatchedAtEntry set, and so does a shell's echo of a typed command that contains req.Text. Match on what the command prints, not on the command: printf 'NEE%s' DLE never puts NEEDLE in the typed line. PaneObservation.WaitFor differs by reporting only output after its baseline. A caller who needs only new output on tmux 3.3a through 3.6 checks the screen before typing and picks text the screen lacks.

Only the visible screen is read, never history, so text that has scrolled off is not seen. Wrapped rows are joined, so text may straddle the wrap column. A poll sees the final state of text a program overwrote with a carriage return, and text printed before a full-screen program started is not on the screen being read.

Every read is one ordinary tmux process, so a server bound to a Connection is refused with ErrConnectionRequiresProcess . Each read runs the owner's after-capture-pane hook, and a hook that prints adds its output to the text. The read asks for liveness through run-shell, which fires no hook.

The text is matched before the pane's liveness is acted on, so a complete read of a pane that has since died still matches. A pane or server that ends first returns a PaneEndedError . A deadline or cancel returns ctx.Err, with the text of the last complete read. An empty req.Text or a negative interval fails before any tmux command runs with ErrInvalidWaitForText .