helix-editor/nucleo
1
0
Fork 0
mirror of https://github.com/helix-editor/nucleo.git synced 2025-10-05 23:32:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

add note to docs about using the high level nucleo crate

Browse Source
This commit is contained in:
Pascal Kuthe
2024-02-20 17:40:27 +01:00
parent 3d46b62546
commit 88a0853025
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
matcher/src/lib.rs
View File

@@ -2,6 +2,11 @@
`nucleo_matcher` is a low level crate that contains the matcher implementation
used by the high level `nucleo` crate.
**NOTE**: If you are building an fzf-like interactive fuzzy finder that is
meant to match a reasonably large number of items (> 100) using the high level
`nucleo` crate is highly recommended. Using `nucleo-matcher` directly in you ui
loop will be very slow. Implementing this logic yourself is very complex.
The matcher is hightly optimized and can significantly outperform `fzf` and
`skim` (the `fuzzy-matcher` crate). However some of these optimizations require
a slightly less convenient API. Be sure to carefully read the documentation of