Skip to content

Commit 0263957

Browse files
committed
Add missing documentation to _with_progress load functions
1 parent 9827603 commit 0263957

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

rust/src/lib.rs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,9 @@ pub fn load(file_path: impl AsRef<Path>) -> Option<Ref<BinaryView>> {
114114
load_with_progress(file_path, NoProgressCallback)
115115
}
116116

117+
/// Equivalent to [`load`] but with a progress callback.
118+
///
119+
/// NOTE: The progress callback will _only_ be called when loading BNDBs.
117120
pub fn load_with_progress<P: ProgressCallback>(
118121
file_path: impl AsRef<Path>,
119122
mut progress: P,
@@ -170,6 +173,9 @@ where
170173
)
171174
}
172175

176+
/// Equivalent to [`load_with_options`] but with a progress callback.
177+
///
178+
/// NOTE: The progress callback will _only_ be called when loading BNDBs.
173179
pub fn load_with_options_and_progress<O, P>(
174180
file_path: impl AsRef<Path>,
175181
update_analysis_and_wait: bool,
@@ -222,6 +228,7 @@ where
222228
load_view_with_progress(bv, update_analysis_and_wait, options, NoProgressCallback)
223229
}
224230

231+
/// Equivalent to [`load_view`] but with a progress callback.
225232
pub fn load_view_with_progress<O, P>(
226233
bv: &BinaryView,
227234
update_analysis_and_wait: bool,

0 commit comments

Comments
 (0)