Struct FilterStateInfo 

pub struct FilterStateInfo {
    pub state: FilterState,
    pub query: String,
    pub match_count: usize,
    pub is_filtering: bool,
    pub is_clearing: bool,
}

Core traits and types for list functionality.

These are the fundamental building blocks for creating custom list items and delegates:

• Item: Trait for displayable and filterable list items
• ItemDelegate: Trait for customizing item rendering and behavior
• FilterState: Enum representing the current filtering state
• FilterStateInfo: Detailed information about filter status

Examples

use bubbletea_widgets::list::{Item, ItemDelegate, FilterState, Model};
use std::fmt::Display;

#[derive(Clone)]
struct MyItem {
    name: String,
    value: i32,
}

impl Display for MyItem {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}: {}", self.name, self.value)
    }
}

impl Item for MyItem {
    fn filter_value(&self) -> String {
        format!("{} {}", self.name, self.value)
    }
}

Detailed information about the current filter state.

This struct provides comprehensive information about the list’s filtering state, making it easy for applications to understand and react to filter conditions without accessing internal list fields directly.

Examples

use bubbletea_widgets::list::{Model, DefaultDelegate, DefaultItem, FilterStateInfo};

let items = vec![DefaultItem::new("Apple", "Red fruit")];
let mut list = Model::new(items, DefaultDelegate::new(), 80, 24);

let state_info = list.filter_state_info();
assert_eq!(state_info.match_count, 1);
assert_eq!(state_info.query, "");
assert!(!state_info.is_filtering);

Fields

state: FilterState

The current filter state.

query: String

The current filter query text.

match_count: usize

Number of items matching the current filter.

is_filtering: bool

Whether any kind of filtering is currently active.

is_clearing: bool

Whether the list is in the process of clearing the filter.

Trait Implementations

impl Clone for FilterStateInfo

fn clone(&self) -> FilterStateInfo

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FilterStateInfo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for FilterStateInfo

fn eq(&self, other: &FilterStateInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for FilterStateInfo

impl StructuralPartialEq for FilterStateInfo