Trait meilisearch_sdk::document::Document

pub trait Document: DeserializeOwned + Debug + Serialize {
    type UIDType: Display;
    fn get_uid(&self) -> &Self::UIDType;
}

Documents are not a predefined structure. You can use your structs as documents by implementing that trait.

WARNING! The get_uid() method MUST only return an object that displays himself only using alphanumeric characters, ‘/’ and ‘-’. Otherwise, the MeiliSearch server will reject your documents.

To be able to use derive with serde, put this line on your Cargo.toml: serde = {version="1.0", features=["derive"]}.

Example

use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Debug)]
struct Movie {
    id: usize,
    name: String,
    description: String,
}

impl Document for Movie {
    type UIDType = usize;

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

Associated Types

type UIDType: Display

The type of the primary key

Required methods

fn get_uid(&self) -> &Self::UIDType

The method returning the primary key of the Document.

WARNING! This method MUST only return an object that displays himself only using alphanumeric characters, ‘/’ and ‘-’. Otherwise, the MeiliSearch server will reject your document.

Implementors