add doc to BatchHandler

2022-05-25 09:26:11 +02:00 · 2022-05-25 09:26:11 +02:00 · 3c85b29865
parent 8349f38197
commit 3c85b29865
1 changed files with 3 additions and 0 deletions
--- a/meilisearch-lib/src/tasks/mod.rs
+++ b/meilisearch-lib/src/tasks/mod.rs
@ -28,6 +28,9 @@ pub trait BatchHandler: Sync + Send + 'static {
    fn accept(&self, batch: &Batch) -> bool;

    /// Processes the `Task` batch returning the batch with the `Task` updated.
+    ///
+    /// It is ok for this function to panic if a batch is handed that hasn't been verified by
+    /// `accept` beforehand.
    async fn process_batch(&self, batch: Batch) -> Batch;

    /// `finish` is called when the result of `process` has been commited to the task store. This