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-go latest

PaneObservation.Reader

Reader returns the pane's output after the baseline as a byte stream: what the program in the pane writes to its terminal, in order, and nothing from any other pane on the connection. Reads block until the pane writes, ctx ends, or the observation closes. A lost observation ends the stream with ErrPaneObservationLost rather than io.EOF. The bytes are the terminal's: escape sequences and carriage returns arrive as written, and the echo of what is typed into the pane arrives before the reply, as it does on screen. Exactly one reader or direct notification read may run at a time.

Source and package
Qualified name
tmux.PaneObservation.Reader
Package
tmux
Declared in
PaneObservation
Distribution
github.com/libtmux/libtmux-go/tmux
Source
tmux/control_observation.go

Description#

A malformed notification on the connection is skipped, as PaneObservation.Notifications skips it; every other error ends the stream.

Parameters

Guides#

Pages that discuss Reader.

Esc

Type to search.

Reference previewOpen reference