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.

enum libtmux-rs latest

PaneProgressState

Closed progress-state vocabulary tmux emits for a pane's progress bar.

Source and package
Qualified name
libtmux::snapshot::PaneProgressState
Module
snapshot
Package
libtmux
Source
crates/libtmux/src/snapshot.rs
enum snapshot.PaneProgressState

Description#

This is public because crate::PaneFields exposes a typed handle for the field, so callers name these variants when filtering.

Examples#

use libtmux::query::Filterable as _;
use libtmux::PaneProgressState;
// Reached as a filter field rather than a getter: tmux only reports it from
// 3.7, so asking for it is a query a caller opts into.
let fields = libtmux::Pane::filter_fields();
let stuck = fields
.pane_pb_state
.is_in([PaneProgressState::Error, PaneProgressState::Paused]);

Variants5#

PaneProgressState variants
CasePayloadDescription
Error No payload Progress display reports an error.
Hidden No payload Progress display is hidden.
Indeterminate No payload Progress is indeterminate.
Normal No payload Progress display is normal.
Paused No payload Progress is paused.
Esc

Type to search.

Reference previewOpen reference