libtmux Reference MCP Search
On this page

control.ControlEvents.shutdown

View as Markdown

Module
control
Declared in
ControlEvents
Package
libtmux
Source
crates/libtmux/src/control.rs
shutdown ( mut ) Result<(), Error>
method [source]
method [source]
shutdown

End the connection and report how it went.

The stream running out says only that the connection is over. This says why, which is the difference between a session that ended and a pipe that broke. It ends the connection outright rather than waiting for the senders, so it is the same call whether the connection is still healthy or tmux hung up an hour ago.

Errors

Returns an error when the connection failed before it was closed.

0 declared, 0 inherited

Esc

Type to search.