Meilisearch Rust: 强大的搜索引擎API客户端

Ray

meilisearch-rust

Meilisearch Rust SDK简介

Meilisearch Rust是Meilisearch搜索引擎的官方Rust API客户端。它为Rust开发者提供了一种简单而强大的方式来集成Meilisearch的搜索功能。

Meilisearch是一个开源的搜索引擎,专为提供快速、相关和易于使用的搜索体验而设计。通过Meilisearch Rust SDK,开发者可以轻松地在他们的Rust应用程序中实现高性能的搜索功能。

Meilisearch Rust Logo

主要特性

完全支持Meilisearch API
异步操作支持
类型安全的API设计
支持自定义HTTP客户端
完全支持WebAssembly(WASM)

安装

要使用Meilisearch Rust SDK,只需在你的Cargo.toml文件中添加以下依赖:

[dependencies]
meilisearch-sdk = "0.27.1"

此外,你可能还需要以下可选依赖:

futures = "0.3" # 用于在非异步运行时中阻塞异步函数
serde = { version = "1.0", features = ["derive"] }

快速开始

添加文档

以下是一个基本示例,展示了如何连接到Meilisearch服务器并添加文档:

use meilisearch_sdk::client::*;
use serde::{Serialize, Deserialize};

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

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new("http://localhost:7700", "masterKey");

    let movies = client.index("movies");

    let documents = vec![
        Movie { id: 1, title: "Carol".to_string(), genres: vec!["Romance".to_string(), "Drama".to_string()] },
        Movie { id: 2, title: "Wonder Woman".to_string(), genres: vec!["Action".to_string(), "Adventure".to_string()] },
        // ... 更多电影
    ];

    movies.add_documents(&documents, Some("id")).await?;

    Ok(())
}

基本搜索

Meilisearch支持容错搜索,这里是一个基本搜索的例子:

let results = client.index("movies")
    .search()
    .with_query("wondr")
    .execute::<Movie>()
    .await?;

println!("{:?}", results.hits);

高级搜索

你可以使用更多参数来自定义搜索:

let results = client.index("movies")
    .search()
    .with_query("wonder")
    .with_filter("genres = Action")
    .with_attributes_to_highlight(["*"])
    .execute::<Movie>()
    .await?;

WebAssembly支持

Meilisearch Rust SDK完全支持WebAssembly,这意味着你可以在浏览器中使用它。使用时需要启用futures-unsend特性:

meilisearch-sdk = { version = "0.27.1", features = ["futures-unsend"] }

与Meilisearch的兼容性

Meilisearch Rust SDK保证与Meilisearch v1.x版本兼容。然而,某些新功能可能尚未实现。请查看GitHub上的issues页面以获取最新信息。

自定义HTTP客户端

默认情况下,SDK使用reqwest库进行HTTP请求。你可以通过实现HttpClient trait来自定义HTTP客户端:

use meilisearch_sdk::http_client::HttpClient;

struct MyHttpClient;

impl HttpClient for MyHttpClient {
    // 实现必要的方法
}

let client = Client::new_with_client("http://localhost:7700", "masterKey", MyHttpClient);