File tree 1 file changed +17
-2
lines changed
1 file changed +17
-2
lines changed Original file line number Diff line number Diff line change @@ -251,10 +251,25 @@ pub const PARQUET_FIELD_ID_META_KEY: &str = "PARQUET:field_id";
251
251
///
252
252
#[ derive( Debug , Clone , PartialEq , Eq ) ]
253
253
pub struct ProjectionMask {
254
- /// If present a leaf column should be included if the value at
254
+ /// If `Some`, a leaf column should be included if the value at
255
255
/// the corresponding index is true
256
256
///
257
- /// If `None`, include all columns
257
+ /// If `None`, all columns should be included
258
+ ///
259
+ /// # Examples
260
+ ///
261
+ /// Given the original parquet schema with leaf columns is `[a, b, c, d]`
262
+ ///
263
+ /// A mask of `[true, false, true, false]` will result in a schema 2
264
+ /// elements long:
265
+ /// * `fields[0]`: `a`
266
+ /// * `fields[1]`: `c`
267
+ ///
268
+ /// A mask of `None` will result in a schema 4 elements long:
269
+ /// * `fields[0]`: `a`
270
+ /// * `fields[1]`: `b`
271
+ /// * `fields[2]`: `c`
272
+ /// * `fields[3]`: `d`
258
273
mask : Option < Vec < bool > > ,
259
274
}
260
275
You can’t perform that action at this time.
0 commit comments