noise_search is both an executable binary that can be run, and a library that can be used in Rust programs.
Installing the command-line executable
Assuming you have Rust/Cargo installed , run this command in a terminal:
cargo install noise_search
It will make the noise_search
command available in your PATH
if you"ve allowed the PATH
to be modified when installing Rust . cargo uninstall noise_search
uninstalls.
Adding noise_search
library as a dependency
Run this command in a terminal, in your project"s directory:
cargo add noise_search
To add it manually, edit your project"s Cargo.toml
file and add to the [dependencies]
section:
noise_search = "0.8.0"
The noise_search
library will be automatically available globally.
Read the noise_search
library documentation .
Back to the crate overview .
Readme
Noise
Nested Object Inverted Search Engine
This is a native library meant to be linked into other projects and will
expose a C API.
It"s a full text index and query system that understands the semi structured
nature of JSON, and will allow:
Stemmed word/fuzzy match
Case sensitive exact word and sentence match
Arbitrary boolean nesting
Greater than/less than matching
Query Language Reference here
Installation
Dependencies
Build
cargo build
Running tests
cargo test
Contributing
Commit messages
Commit messages are important as soon as you need to dig into the history
of certain parts of the system. Hence please follow the guidelines of
How to Write a Git Commit Message .
License
Licensed under either of
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally
submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.