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

Pane.is_in_mode

Report whether the pane is in copy mode or another pane mode.

Source and package
Qualified name
libtmux::pane::Pane::is_in_mode
Module
pane
Declared in
Pane
Package
libtmux
Source
crates/libtmux/src/pane.rs
Other languages
Perl Erlang PowerShell Julia Elixir Haskell Common Lisp Python Ruby Lua TypeScript Go Java C# C++ Swift Kotlin Scala OCaml F# Clojure
#[must_use] pub fn is_in_mode(&self) -> bool

Description#

tmux reports this as a count rather than a flag, so any nonzero value means the pane has a mode open.

In other ports#

Whether the pane is in a mode

Equivalents of Whether the pane is in a mode in other languages
Language Equivalent
Python libtmux.Pane.pane_in_mode
Haskell No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
TypeScript no equivalent on Pane
Go tmux.Pane.InMode
Java Pane.mode names the mode rather than reporting a flag
C# no equivalent on Pane
C++ libtmux::Pane::in_mode
Swift no equivalent on Pane
OCaml No direct public OCaml equivalent is recorded for this operation.
Perl No dedicated equivalent in the selected Perl surface. Explicit Server::cmd remains available for native tmux commands.

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

Esc

Type to search.

Reference previewOpen reference