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);

Implementations

impl PickerOptions

pub fn new() -> Self

Initialize with default configuration.

Equivalent to the Default implementation.

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

Convert into a Picker.

pub 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 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 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

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

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

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

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

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

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

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

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

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

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

How to treat case mismatch (default to CaseMatching::default).

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

How to perform Unicode normalization (default to Normalization::default).

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

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

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

👎Deprecated since 0.6.2: method has been renamed to highlight_padding

How much space to leave after rendering the rightmost highlight.

Trait Implementations

impl Default for PickerOptions

fn default() -> Self

Returns the “default value” for a type.