MeiliSearch Rust SDK

MeiliSearch | Documentation | Slack | Roadmap | Website | FAQ

⚡ The MeiliSearch API client written for Rust 🦀

MeiliSearch Rust is the MeiliSearch API client for Rust developers.

MeiliSearch is an open-source search engine. Discover what MeiliSearch is!

Table of Contents

• 📖 Documentation
• 🔧 Installation
• 🚀 Getting Started
• 🌐 Running in the Browser with WASM
• 🤖 Compatibility with MeiliSearch
• ⚙️ Development Workflow and Contributing

📖 Documentation

See our Documentation or our API References.

🔧 Installation

To use meilisearch-sdk, add this to your Cargo.toml:

[dependencies]
meilisearch-sdk = "0.13.0"

The following optional dependencies may also be useful:

futures = "0.3" # To be able to block on async functions if you are not using an async runtime
serde = { version = "1.0", features = ["derive"] }

This crate is async but you can choose to use an async runtime like tokio or just block on futures. You can enable the sync feature to make most structs Sync. It may be a bit slower.

Using this crate is possible without serde, but a lot of features require serde.

Run a MeiliSearch Instance

This crate requires a MeiliSearch server to run.

There are many easy ways to download and run a MeiliSearch instance.

For example,using the curl command in your Terminal:

# Install MeiliSearch
curl -L https://install.meilisearch.com | sh

# Launch MeiliSearch
./meilisearch --master-key=masterKey

NB: you can also download MeiliSearch from Homebrew or APT.

🚀 Getting Started

Add Documents

use meilisearch_sdk::{document::*, client::*};
use serde::{Serialize, Deserialize};
use futures::executor::block_on;

#[derive(Serialize, Deserialize, Debug)]
struct Movie {
    id: usize,
    title: String,
    genres: Vec<String>,
}

// That trait is required to make a struct usable by an index
impl Document for Movie {
    type UIDType = usize;

    fn get_uid(&self) -> &Self::UIDType {
        &self.id
    }
}

fn main() { block_on(async move {
    // Create a client (without sending any request so that can't fail)
    let client = Client::new("http://localhost:7700", "masterKey");

    // An index is where the documents are stored.
    let movies = client.index("movies");

    // Add some movies in the index. If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
    movies.add_documents(&[
        Movie{id: 1, title: String::from("Carol"), genres: vec!["Romance".to_string(), "Drama".to_string()]},
        Movie{id: 2, title: String::from("Wonder Woman"), genres: vec!["Action".to_string(), "Adventure".to_string()]},
        Movie{id: 3, title: String::from("Life of Pi"), genres: vec!["Adventure".to_string(), "Drama".to_string()]},
        Movie{id: 4, title: String::from("Mad Max"), genres: vec!["Adventure".to_string(), "Science Fiction".to_string()]},
        Movie{id: 5, title: String::from("Moana"), genres: vec!["Fantasy".to_string(), "Action".to_string()]},
        Movie{id: 6, title: String::from("Philadelphia"), genres: vec!["Drama".to_string()]},
    ], Some("id")).await.unwrap();
})}

Basic Search

// MeiliSearch is typo-tolerant:
println!("{:?}", client.index("movies").search().with_query("caorl").execute::<Movie>().await.unwrap().hits);

Output:

[Movie{id: 1, title: String::from("Carol"), genres: vec!["Romance", "Drama"]}]

Json output:

{
  "hits": [{
    "id": 1,
    "title": "Carol",
    "genres": ["Romance", "Drama"]
  }],
  "offset": 0,
  "limit": 10,
  "processingTimeMs": 1,
  "query": "caorl"
}

Custom Search

println!("{:?}", client.index("movies").search().with_query("phil").with_attributes_to_highlight(Selectors::Some(&["*"])).execute::<Movie>().await.unwrap().hits);

Json output:

{
    "hits": [
        {
            "id": 6,
            "title": "Philadelphia",
            "_formatted": {
                "id": 6,
                "title": "<em>Phil</em>adelphia",
                "genre": ["Drama"]
            }
        }
    ],
    "offset": 0,
    "limit": 20,
    "processingTimeMs": 0,
    "query": "phil"
}

Custom Search With Filters

If you want to enable filtering, you must add your attributes to the filterableAttributes index setting.

let filterable_attributes = [
    "id",
    "genres"
];
client.index("movies").set_filterable_attributes(&filterable_attributes).await.unwrap();

You only need to perform this operation once.

Note that MeiliSearch will rebuild your index whenever you update filterableAttributes. Depending on the size of your dataset, this might take time. You can track the whole process using the update status.

Then, you can perform the search:

println!("{:?}", client.index("movies").search().with_query("wonder").with_filter("id > 1 AND genres = Action")
.execute::<Movie>().await.unwrap().hits);

Json output:

{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action", "Adventure"]
    }
  ],
  "offset": 0,
  "limit": 20,
  "nbHits": 1,
  "processingTimeMs": 0,
  "query": "wonder"
}

🌐 Running in the Browser with WASM

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 our demo.

WARNING: meilisearch-sdk will panic if no Window is available (ex: Web extension).

🤖 Compatibility with MeiliSearch

This package only guarantees the compatibility with the version v0.24.0 of MeiliSearch.

⚙️ Development Workflow and Contributing

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.