Skip to main content

SearchableVec

Struct SearchableVec 

Source
pub struct SearchableVec<T> { /* private fields */ }
Expand description

A vector of items that supports incremental filtering.

On each perform_search call the matched_items view is rebuilt by filtering the full items list. Use this as a delegate when all data is already in memory.

Implementations§

Source§

impl<T: Clone> SearchableVec<T>

Source

pub fn new(items: impl Into<Vec<T>>) -> Self

Create a new SearchableVec from an initial list of items.

Source

pub fn push(&mut self, item: T)

Append an item to both the master list and the current filtered view.

Trait Implementations§

Source§

impl<T: Clone> Clone for SearchableVec<T>

Source§

fn clone(&self) -> SearchableVec<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for SearchableVec<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: SearchableListItem> From<Vec<T>> for SearchableVec<T>

Source§

fn from(items: Vec<T>) -> Self

Converts to this type from the input type.
Source§

impl<I: SearchableListItem + 'static> SearchableListDelegate for SearchableVec<I>

Source§

type Item = I

Source§

fn items_count(&self, _: usize) -> usize

Number of items in the given section.
Source§

fn item(&self, ix: IndexPath) -> Option<&Self::Item>

Return a reference to the item at the given index path.
Source§

fn position<V>(&self, value: &V) -> Option<IndexPath>
where Self::Item: SearchableListItem<Value = V>, V: PartialEq,

Find the index path of the item whose value equals value.
Called when the search query changes. Read more
Source§

fn sections_count(&self, _: &App) -> usize

Number of sections (groups) in the list. Defaults to 1.
Source§

fn section(&self, _section: usize) -> Option<AnyElement>

👎Deprecated
Optional header element for the given section index. Read more
Source§

fn render_item( &self, _ix: IndexPath, _item: &Self::Item, _checked: bool, _window: &mut Window, _cx: &mut App, ) -> Option<AnyElement>

Override the row content for the item at ix. Read more
Source§

fn render_section_header( &self, _section: usize, _window: &mut Window, _cx: &mut App, ) -> Option<AnyElement>

Render the header element for the given section (full render access). Read more
Source§

fn is_item_enabled(&self, _ix: IndexPath, item: &Self::Item, _cx: &App) -> bool

Whether the item at ix should be rendered as interactive. Read more
Source§

fn is_item_checked( &self, _ix: IndexPath, item: &Self::Item, current_selection: &[(IndexPath, Self::Item)], _cx: &App, ) -> bool

Whether the item at ix should show a checkmark. Read more
Source§

fn on_will_change( &mut self, selection: &mut Vec<(IndexPath, Self::Item)>, changes: &[SearchableListChange], )

Called before a user-triggered selection change is committed. Read more
Source§

fn on_confirm(&mut self, _final_selection: &[(IndexPath, Self::Item)])

Called when the dropdown/popover is committed (Escape, close_on_select, or explicit confirm). final_selection is the selection after the last committed change.
Source§

impl<I: SearchableListItem + 'static> SearchableListDelegate for SearchableVec<SearchableGroup<I>>

Source§

type Item = I

Source§

fn sections_count(&self, _: &App) -> usize

Number of sections (groups) in the list. Defaults to 1.
Source§

fn items_count(&self, section: usize) -> usize

Number of items in the given section.
Source§

fn section(&self, section: usize) -> Option<AnyElement>

👎Deprecated
Optional header element for the given section index. Read more
Source§

fn item(&self, ix: IndexPath) -> Option<&Self::Item>

Return a reference to the item at the given index path.
Source§

fn position<V>(&self, value: &V) -> Option<IndexPath>
where Self::Item: SearchableListItem<Value = V>, V: PartialEq,

Find the index path of the item whose value equals value.
Source§

fn perform_search( &mut self, query: &str, _: &mut Window, _: &mut App, ) -> Task<()>

Called when the search query changes. Read more
Source§

fn render_item( &self, _ix: IndexPath, _item: &Self::Item, _checked: bool, _window: &mut Window, _cx: &mut App, ) -> Option<AnyElement>

Override the row content for the item at ix. Read more
Source§

fn render_section_header( &self, _section: usize, _window: &mut Window, _cx: &mut App, ) -> Option<AnyElement>

Render the header element for the given section (full render access). Read more
Source§

fn is_item_enabled(&self, _ix: IndexPath, item: &Self::Item, _cx: &App) -> bool

Whether the item at ix should be rendered as interactive. Read more
Source§

fn is_item_checked( &self, _ix: IndexPath, item: &Self::Item, current_selection: &[(IndexPath, Self::Item)], _cx: &App, ) -> bool

Whether the item at ix should show a checkmark. Read more
Source§

fn on_will_change( &mut self, selection: &mut Vec<(IndexPath, Self::Item)>, changes: &[SearchableListChange], )

Called before a user-triggered selection change is committed. Read more
Source§

fn on_confirm(&mut self, _final_selection: &[(IndexPath, Self::Item)])

Called when the dropdown/popover is committed (Escape, close_on_select, or explicit confirm). final_selection is the selection after the last committed change.

Auto Trait Implementations§

§

impl<T> Freeze for SearchableVec<T>
where Vec<T>: Freeze,

§

impl<T> RefUnwindSafe for SearchableVec<T>
where Vec<T>: RefUnwindSafe,

§

impl<T> Send for SearchableVec<T>
where Vec<T>: Send,

§

impl<T> Sync for SearchableVec<T>
where Vec<T>: Sync,

§

impl<T> Unpin for SearchableVec<T>
where Vec<T>: Unpin,

§

impl<T> UnsafeUnpin for SearchableVec<T>
where Vec<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for SearchableVec<T>
where Vec<T>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more