Skip to content

Commit 3939373

Browse files
committed
chore: add some rustdoc for a new/temporary public method
Signed-off-by: R. Tyler Croy <rtyler@brokenco.de>
1 parent 8777b90 commit 3939373

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

crates/core/src/kernel/snapshot/iterators.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,10 @@ impl LogicalFileView {
242242
.map(|s| round_ms_datetimes(s, &ceil_datetime))
243243
}
244244

245+
/// Return the underlying [DeletionVectorDescriptor] if it exists.
246+
///
247+
/// **NOTE**: THis API may be removed in the future without deprecation warnings as the
248+
/// utilization of deletion vectors inside of delta-rs becomes more sophisticated.
245249
pub fn deletion_vector_descriptor(&self) -> Option<DeletionVectorDescriptor> {
246250
self.deletion_vector().map(|dv| dv.descriptor())
247251
}

0 commit comments

Comments
 (0)