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.

trait libtmux-rs latest

FilterEnum

Stable string semantics for a custom enum filter field.

Source and package
Qualified name
libtmux::query::FilterEnum
Module
query
Package
libtmux
Source
crates/libtmux/src/query.rs
trait query.FilterEnum

Description#

Every value returned by FilterEnum::filter_name() must be present in FilterEnum::FILTER_VARIANTS, and the variant names must be unique.

Examples#

use libtmux::query::FilterEnum;
enum State {
Ready,
Blocked,
}
impl FilterEnum for State {
const FILTER_VARIANTS: &'static [&'static str] = &["ready", "blocked"];
fn filter_name(&self) -> &'static str {
match self {
Self::Ready => "ready",
Self::Blocked => "blocked",
}
}
}
assert_eq!(State::Ready.filter_name(), "ready");

Members1#

  • filter_name method Return this value's stable filter string.
Esc

Type to search.

Reference previewOpen reference