Struct PickerOptions 

pub struct PickerOptions { /* private fields */ }

Specify configuration options for a Picker.

Initialize with new or (equivalently) the Default implementation, specify options, and then convert to a Picker using the picker method.

Example

use nucleo_picker::{render::StrRenderer, Picker, PickerOptions};

let picker: Picker<String, _> = PickerOptions::new()
    .highlight(true)
    .query("search")
    .picker(StrRenderer);

Sort order settings

There are three settings which influence the order in which items appear on the screen.

The reversed setting only influences the layout: by default, the query is placed at the bottom of the screen, with the match list rendered bottom-up. If this is set, the query will be placed at the top of the screen, with the match list rendered top-down.

The reverse_items and sort_results are used to determine the order of the items inside the match list. The order is defined according to the following table. Here, Index refers to the order in which the picker received the items from the Injectors. If you use exactly one injector, this is guaranteed to be the same as the insertion order.

sort_results	reverse_items	Sort priority
true	false	Score (desc) → Length (asc) → Index (asc)
true	true	Score (desc) → Length (asc) → Index (desc)
false	false	Index (asc)
false	true	Index (desc)

Implementations

impl PickerOptions

pub const fn new() -> Self

Initialize with default configuration.

Equivalent to the Default implementation, but as a const fn.

pub fn picker<T: Send + Sync + 'static, R: Render<T>>( self, render: R, ) -> Picker<T, R>

Convert into a Picker.

pub const fn reversed(self, reversed: bool) -> Self

Set ‘reversed’ layout.

Option false (default) will put the prompt at the bottom and render items in ascending order. Option true will put the prompt at the top and render items in descending order.

pub const fn reverse_items(self, reversed: bool) -> Self

Reverse the item insert order.

This changes the index tie-break method to prefer later indices rather than earlier indices. This option is typically used with sort_results set to false, in which case the newest items sent to the picker will be placed first, rather than last.

The default is false.

pub const fn sort_results(self, sort: bool) -> Self

Whether or not to sort matching items by score.

This option is useful when you just want to filter items, but preserve the original order. By default, the oldest items will appear at the beginning and the newest items will appear at the end. This can be swapped by setting reverse_items to true.

pub const fn frame_interval(self, interval: Duration) -> Self

Set how long each frame should last.

This is the reciprocal of the refresh rate. The default value is Duration::from_millis(15), which corresponds to a refresh rate of approximately 67 frames per second. It is not recommended to set this to a value less than 8ms.

pub const fn threads(self, threads: Option<NonZero<usize>>) -> Self

Set the number of threads used by the internal matching engine.

If None (default), use a heuristic choice based on the amount of available parallelism along with other factors.

pub fn config(self, config: Config) -> Self

👎Deprecated since 0.10.0: Use native methods prefer_prefix and match_paths. The normalize and ignore_case settings are never used; use normalization and case_matching instead.

Set the internal match engine configuration (default to nucleo::Config::DEFAULT).

pub const fn normalization(self, normalization: Normalization) -> Self

How to perform Unicode normalization (defaults to Normalization::Smart).

pub const fn case_matching(self, case_matching: CaseMatching) -> Self

How to treat case mismatch (defaults to CaseMatching::Smart).

pub const fn match_paths(self) -> Self

Enable score bonuses appropriate for matching file paths.

pub const fn prefer_prefix(self, prefer_prefix: bool) -> Self

Whether to provide a bonus to matches by their distance from the start of the item.

This is disabled by default and only recommended for autocompletion use-cases, where the expectation is that the user is typing the entire match.

pub const fn highlight(self, highlight: bool) -> Self

Whether or not to highlight matches (default to true).

pub const fn highlight_padding(self, size: u16) -> Self

How much space to leave when rendering match highlighting (default to 3).

pub const fn scroll_padding(self, size: u16) -> Self

How much space to leave around the selection when scrolling (default to 3).

pub const fn prompt_padding(self, size: u16) -> Self

How much space to leave around the cursor (default to 2).

pub fn query<Q: Into<String>>(self, query: Q) -> Self

Provide an initial query string for the prompt (default to "").

Trait Implementations

impl Default for PickerOptions

fn default() -> Self

Returns the “default value” for a type.