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

ControlSender.unsubscribe

Stop reporting a format this connection subscribed to.

Source and package
Qualified name
libtmux::control::ControlSender::unsubscribe
Module
control
Declared in
ControlSender
Package
libtmux
Source
crates/libtmux/src/control.rs
pub async fn unsubscribe(&self, name: &str) -> Result< (), Error >

Description#

tmux removes a subscription when it is named with no colon after it, which is why this cannot be spelled as Self::subscribe() with an empty format: that would replace the subscription rather than remove it.

Errors

Returns an error when the connection has closed, tmux refuses the request, or the name is empty or contains a colon.

Parameters

tmux command#

The tmux commands behind unsubscribe.

tmux C API#

The C declarations in tmux that implement these commands.

Esc

Type to search.

Reference previewOpen reference