Skip to main content

Picker

Struct Picker 

Source
pub struct Picker { /* private fields */ }
Expand description

An open picker: the fleet’s narrowing machine plus escriba’s source.

Implementations§

Source§

impl Picker

Source

pub fn open(source: Source, items: Vec<PickerItem<Choice>>) -> Self

Open a picker over items.

Source

pub const fn source(&self) -> Source

Source

pub fn refresh_items(&mut self, items: Vec<PickerItem<Choice>>) -> bool

Replace the rows from a live producer, if it is safe to do so.

A scan posts results in batches while the operator is already looking at the picker, so the row set grows under them. FuzzyPicker::set_items preserves the query and the open state but resets the highlight to the top — so re-listing under someone who has scrolled down would move their selection on every batch, which is worse than showing them fewer rows.

The rule: refresh only while the highlight is still where it started. Once the operator navigates, they have chosen a row set to work with and keep it. Returns whether the refresh was taken, so a caller can tell the difference between “updated” and “deliberately left alone”.

Source

pub fn is_at_top(&self) -> bool

Is the highlight still on the first visible row — i.e. has the operator not navigated yet?

An empty picker counts as “at the top”: there is nothing to have moved away from, and the first batch must be able to land.

Source

pub fn query(&self) -> &str

Source

pub fn visible_count(&self) -> usize

Source

pub fn rows(&self) -> Vec<(String, bool)>

The rows to paint, as (label, selected).

Borrowed from the machine rather than copied, so a face cannot paint a stale view.

Source

pub fn on_key(&mut self, key: &Key) -> Consumed

Feed a key. None for a key the picker has no meaning for — which is HELD rather than passed through, because a picker that let unknown keys reach the buffer would edit the file behind the overlay.

Trait Implementations§

Source§

impl Debug for Picker

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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