MicroscopeMatcher

Struct MicroscopeMatcher 

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

Streaming fuzzy matcher using Nucleo

Provides non-blocking fuzzy matching with progressive results. Items are injected via Injector and results are retrieved via snapshot().

§Example

let matcher = MicroscopeMatcher::new();

// Get injector for background task
let injector = matcher.injector();
tokio::spawn(async move {
    for item in items {
        injector.push(MatcherItem::new(item), |mi, cols| {
            cols[0] = mi.match_text.clone();
        });
    }
});

// In render loop
matcher.tick(10); // Process for max 10ms
let results = matcher.get_matched_items(100); // Get top 100 results

Implementations§

Source§

impl MicroscopeMatcher

Source

pub fn new() -> Self

Create a new streaming matcher

Uses smart case matching and Unicode normalization. Spawns worker threads for parallel matching.

Source

pub fn injector(&self) -> Injector<MatcherItem>

Get an injector for pushing items from background tasks

The injector is thread-safe and can be cloned and sent to other threads.

Source

pub fn set_pattern(&mut self, query: &str)

Update the search pattern

This triggers re-matching of all items against the new pattern.

Source

pub fn tick(&mut self, timeout_ms: u64) -> MatcherStatus

Process pending matches (non-blocking)

Call this regularly (e.g., in render loop) to process matches. Returns status indicating if more processing is needed.

§Arguments
  • timeout_ms - Maximum time to spend processing (in milliseconds)
Source

pub fn get_matched_items(&self, max_items: usize) -> Vec<MicroscopeItem>

Get matched items from the current snapshot

Returns items sorted by match score (best matches first). This is instant and does not block.

Note: The items are pre-sorted by nucleo, so the order reflects the ranking. Individual scores are not exposed by nucleo’s streaming API, so we use the item index as a rough score proxy (lower = better match).

§Arguments
  • max_items - Maximum number of items to return
Source

pub fn total_count(&self) -> u32

Get total number of items in the matcher

Source

pub fn matched_count(&self) -> u32

Get number of items matching the current pattern

Source

pub fn is_pattern_empty(&self) -> bool

Check if pattern is empty (all items match)

Source

pub fn restart(&mut self)

Restart the matcher (clear all items)

Call this when switching pickers or starting a new search.

Source

pub fn restart_with_clear(&mut self)

Restart and also clear the pattern

Trait Implementations§

Source§

impl Default for MicroscopeMatcher

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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, 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> 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