Nucleo-picker-engine

The ncp-engine crate is a fork of the nucleo crate. It is not recommended for general use. This fork mainly exists to meet the specific requirements of nucleo-picker.

ncp-engine implements a high level matcher API that provides a performant parallel matcher worker threadpool. It is designed to allow integrating a fzf-like fuzzy matcher into a TUI application.

For a fully-featured TUI implementation, see nucleo-picker.

Matching runs in a background threadpool while providing a snapshot of the last complete match on request. That means the matcher can update the results live while the user is typing, while never blocking the main UI thread (beyond a user provided timeout). Nucleo also supports fully concurrent lock-free (and wait-free) streaming of input items.

The Nucleo struct serves as the main API entrypoint for this crate.

[!WARNING] This is an unstable fork of helix-editor/nucleo. You probably don't want to use this crate; there are no plans for stable releases and could change substantially between minor version changes.

This is a fork of nucleo which has some modifications to better support the requirements in nucleo-picker.

This fork branched at commit hash 5b74652e482f7c07d827f18c6d21e7540c242c69.

The current differences are:

• Updated dependencies and migrated to 2024 edition
• Renamed Nucleo::extend to Nucleo::extend_exact to better reflect implementation.