This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new fc21cfbb9c Clarify GenericColumnReader::read_records (#4540)
fc21cfbb9c is described below
commit fc21cfbb9c4b1238570430a848fa4cd71adb84cb
Author: Raphael Taylor-Davies <[email protected]>
AuthorDate: Sat Jul 22 12:19:24 2023 -0400
Clarify GenericColumnReader::read_records (#4540)
* Clarify GenericColumnReader::read_records
* Review feedback
---
parquet/src/column/reader.rs | 13 ++++++++-----
1 file changed, 8 insertions(+), 5 deletions(-)
diff --git a/parquet/src/column/reader.rs b/parquet/src/column/reader.rs
index 13af8233d4..3ce00622e9 100644
--- a/parquet/src/column/reader.rs
+++ b/parquet/src/column/reader.rs
@@ -212,14 +212,17 @@ where
Ok((values, levels))
}
- /// Read up to `max_records` returning the number of complete records,
non-null
- /// values and levels decoded
+ /// Read up to `max_records` whole records, returning the number of
complete
+ /// records, non-null values and levels decoded. All levels for a given
record
+ /// will be read, i.e. the next repetition level, if any, will be 0
///
- /// If the max definition level is 0, `def_levels` will be ignored,
otherwise it will be
+ /// If the max definition level is 0, `def_levels` will be ignored and the
number of records,
+ /// non-null values and levels decoded will all be equal, otherwise
`def_levels` will be
/// populated with the number of levels read, with an error returned if it
is `None`.
///
- /// If the max repetition level is 0, `rep_levels` will be ignored,
otherwise it will be
- /// populated with the number of levels read, with an error returned if it
is `None`.
+ /// If the max repetition level is 0, `rep_levels` will be ignored and the
number of records
+ /// and levels decoded will both be equal, otherwise `rep_levels` will be
populated with
+ /// the number of levels read, with an error returned if it is `None`.
///
/// `values` will be contiguously populated with the non-null values. Note
that if the column
/// is not required, this may be less than either `max_records` or the
number of levels read
