Rust API

method libtmux-rs latest

Window.unset_option

Remove one option, restoring whatever it inherits.

Source and package

Qualified name: libtmux::window::Window::unset_option
Module: window
Declared in: Window
Package: libtmux
Source: crates/libtmux/src/window/settings.rs
Other languages: Perlmethod Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby LuaTypeScriptGo Java C# C++Swift Kotlin Scala OCaml F# Clojure

pub async fn unset_option(&self, name: &str) -> Result< (), Error > method async [source] ¶

Description#

Errors

Returns an error when tmux rejects the name.

Returns crate::Error::OptionScopeMismatch when tmux keeps the option in another of its tables.

Parameters

The tmux commands behind unset_option.

The C declarations in tmux that implement these commands.

Settings for the server, sessions, windows and panes, with their types, defaults and allowed values.

Unset a window option

Equivalents of Unset a window option in other languages
Language	Equivalent
Python	`libtmux.Window.unset_option`
Lua	`libtmux.Window:unset_option`
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript	`window.Window.unsetOption`
Go	`tmux.Window.UnsetOption`
Java	reached through `Window.options`, whose `Options` carries the write
C#	reached through `Window.Options`, whose `TmuxOptions` carries the write
C++	`libtmux::Window::unset_option`
Swift	`Server.unsetOption(_:scope:)`
OCaml	`Libtmux_unix.Client.unset_option`
Perl	`LibTmux::Server::unset_option` Pass scope => 'window' and the explicit target ID where applicable; inherited and global reads are deliberate options.

No equivalent is recorded in Ruby, PowerShell, Julia, Erlang, Elixir, Common Lisp, Clojure, Kotlin, Scala or F#.