Struct meilisearch_sdk::progress::Progress

pub struct Progress { /* fields omitted */ }

A struct used to track the progress of some async operations.

Implementations

impl<'a> Progress

pub fn get_update_id(&self) -> u64

let client = Client::new("http://localhost:7700", "masterKey");
let mut movies_index = client.get_or_create("movies").await.unwrap();
let progress = movies_index.delete_all_documents().await.unwrap();
let update_id = progress.get_update_id();

pub async fn get_status(&self) -> Result<UpdateStatus, Error>

Example

let client = Client::new("http://localhost:7700", "masterKey");
let mut movies_index = client.get_or_create("movies").await.unwrap();
let progress = movies_index.delete_all_documents().await.unwrap();
let status = progress.get_status().await.unwrap();

pub async fn wait_for_pending_update(
    &self,
    interval: Option<Duration>,
    timeout: Option<Duration>
) -> Option<Result<UpdateStatus, Error>>

Wait until MeiliSearch processes an update, and get its status.

interval = The frequency at which the server should be polled. Default = 50ms timeout = The maximum time to wait for processing to complete. Default = 5000ms

If the waited time exceeds timeout then None will be returned.

Example

let client = Client::new("http://localhost:7700", "masterKey");
let movies = client.index("movies_wait_for_pending");

let progress = movies.add_documents(&[
    Document { id: 0, kind: "title".into(), value: "The Social Network".to_string() },
    Document { id: 1, kind: "title".into(), value: "Harry Potter and the Sorcerer's Stone".to_string() },
], None).await.unwrap();

let status = progress.wait_for_pending_update(None, None).await.unwrap();

assert!(matches!(status.unwrap(), UpdateStatus::Processed { .. }));