⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Rust
MeiliSearch Rust is a client for MeiliSearch written in Rust. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.
To use meilisearch-sdk, add this to your Cargo.toml:
toml
[dependencies]
meilisearch-sdk = "0.3.0"
The following optional dependencies may also be useful:
toml
tokio = { version = "0.2", features = ["macros"] }
serde = { version = "1.0", features = ["derive"] }
Since this crate is async, you have to run your program in the tokio runtime. When targetting Wasm, the browser will replace tokio.
Using this crate is possible without serde, but a lot of features require serde.
This crate requires a MeiliSearch server to run.
There are many easy ways to download and run a MeiliSearch instance.
For example, if you use Docker:
bash
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
NB: you can also download MeiliSearch from Homebrew or APT.
```rust use meilisearch_sdk::{document::, client::, search::*}; use serde::{Serialize, Deserialize};
struct Book { book_id: usize, title: String, }
// That trait is required to make a struct usable by an index impl Document for Book { type UIDType = usize;
fn get_uid(&self) -> &Self::UIDType {
&self.book_id
}
}
async fn main() { // Create a client (without sending any request so that can't fail) let client = Client::new("http://localhost:7700", "masterKey");
// Get the index called "books"
let books = client.get_or_create("books").await.unwrap();
// Add some books in the index
books.add_documents(&[
Book{book_id: 123, title: String::from("Pride and Prejudice")},
Book{book_id: 456, title: String::from("Le Petit Prince")},
Book{book_id: 1, title: String::from("Alice In Wonderland")},
Book{book_id: 1344, title: String::from("The Hobbit")},
Book{book_id: 4, title: String::from("Harry Potter and the Half-Blood Prince")},
Book{book_id: 42, title: String::from("The Hitchhiker's Guide to the Galaxy")},
], Some("book_id")).await.unwrap();
// Query books (note that there is a typo)
let query = Query::new("harry pottre");
println!("{:?}", books.search::<Book>(&query).await.unwrap().hits);
} ```
Output:
[Book { book_id: 4, title: "Harry Potter and the Half-Blood Prince" }]
This crate fully supports WASM.
The only difference between the WASM and the native version is that the native version has one more variant (Error::Http) in the Error enum. That should not matter so much but we could add this variant in WASM too.
However, making a program intended to run in a web browser requires a very different design than a CLI program. To see an example of a simple Rust web app using MeiliSearch, see the tutorial (not available yet).
WARNING: meilisearch-sdk will panic if no Window is available (ex: Web extension).
This package is compatible with the following MeiliSearch versions:
- v0.13.X
Any new contribution is more than welcome in this project!
If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!
MeiliSearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.