From 819c0cbedcc6c7f0f8aba628a7a2875b7181e3f7 Mon Sep 17 00:00:00 2001
From: Mason Reed <mason@vector35.com>
Date: Fri, 25 Jul 2025 23:13:39 -0400
Subject: [Rust] Add docs for what the boolean return value does for some
 specific "progress" like callbacks

Still need to add more, consider changing the boolean to an enum that describes it better, so we do not need to copy paste docs around.
---
 rust/src/progress.rs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'rust/src/progress.rs')

diff --git a/rust/src/progress.rs b/rust/src/progress.rs
index 5ebf8273..e6897e68 100644
--- a/rust/src/progress.rs
+++ b/rust/src/progress.rs
@@ -2,6 +2,10 @@ use std::ffi::c_void;
 
 pub trait ProgressCallback: Sized {
     type SplitProgressType: SplitProgressBuilder;
+    
+    /// Caller function will call this to report progress.
+    /// 
+    /// Return `false` to tell the caller to stop.
     fn progress(&mut self, progress: usize, total: usize) -> bool;
 
     unsafe extern "C" fn cb_progress_callback(
-- 
cgit v1.3.1