mirror of
https://github.com/meilisearch/MeiliSearch
synced 2024-11-22 12:54:26 +01:00
add doc to BatchHandler
This commit is contained in:
parent
8349f38197
commit
3c85b29865
@ -28,6 +28,9 @@ pub trait BatchHandler: Sync + Send + 'static {
|
|||||||
fn accept(&self, batch: &Batch) -> bool;
|
fn accept(&self, batch: &Batch) -> bool;
|
||||||
|
|
||||||
/// Processes the `Task` batch returning the batch with the `Task` updated.
|
/// 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;
|
async fn process_batch(&self, batch: Batch) -> Batch;
|
||||||
|
|
||||||
/// `finish` is called when the result of `process` has been commited to the task store. This
|
/// `finish` is called when the result of `process` has been commited to the task store. This
|
||||||
|
Loading…
Reference in New Issue
Block a user