Skip to content

Commit f480bfe

Browse files
michielp1807folkertdev
authored andcommitted
fn ZDICT_optimizeTrainFromBuffer_cover: improve safety comment
1 parent f5ee0ad commit f480bfe

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

lib/dictBuilder/cover.rs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1204,7 +1204,13 @@ fn COVER_tryParameters(data: Box<COVER_tryParameters_data_t>) {
12041204
///
12051205
/// Behavior is undefined if any of the following conditions are violated:
12061206
///
1207-
/// - `parameters` satisfies the conditions of [`pointer::as_mut`]
1207+
/// - `dictBufferCapacity` is 0 or `dictBuffer` and `dictBufferCapacity` satisfy the requirements
1208+
/// of [`core::slice::from_raw_parts_mut`].
1209+
/// - `nbSamples` is 0 or `samplesSizes` and `nbSamples` satisfy the requirements
1210+
/// of [`core::slice::from_raw_parts`].
1211+
/// - `sum(samplesSizes)` is 0 or `samplesBuffer` and `sum(samplesSizes)` satisfy the requirements
1212+
/// of [`core::slice::from_raw_parts`].
1213+
/// - `parameters` satisfies the requirements of [`pointer::as_mut`]
12081214
#[cfg_attr(feature = "export-symbols", export_name = crate::prefix!(ZDICT_optimizeTrainFromBuffer_cover))]
12091215
pub unsafe extern "C" fn ZDICT_optimizeTrainFromBuffer_cover(
12101216
dictBuffer: *mut core::ffi::c_void,

0 commit comments

Comments
 (0)