Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

function libtmux-erlang latest

tmux_pane:stop_pipe/1

Close this registered pane's native pipe, performing I/O. On a live pane, closing an already closed pipe succeeds. An exited pane can produce a native command error; a vanished ID returns target_gone.

Source and package
Qualified name
tmux_pane:stop_pipe/1
Declared in
tmux_pane
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_pane.erl
stop_pipe(Pane) -spec stop_pipe(tmux_model:pane()) -> {ok, map()} | {error, map()}.

Description#

Closing can discard pending bytes. It neither kills nor waits for an arbitrary shell job started by pipe/3; applications must verify consumption and process completion themselves. The endpoint does not own that shell process.

Parameters

tmux command#

The tmux commands behind stop_pipe/1.

tmux C API#

The C declarations in tmux that implement these commands.

Guides#

Pages that discuss stop_pipe/1.

Esc

Type to search.

Reference previewOpen reference