parquet/record/record_reader.rs
1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License. You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use super::super::errors::ParquetError;
19use super::super::file::reader::RowGroupReader;
20
21/// Read up to `num_records` records from `row_group_reader` into `self`.
22///
23/// The type parameter `T` is used to work around the rust orphan rule
24/// when implementing on types such as `Vec<T>`.
25pub trait RecordReader<T> {
26 /// Read up to `num_records` records from `row_group_reader` into `self`.
27 fn read_from_row_group(
28 &mut self,
29 row_group_reader: &mut dyn RowGroupReader,
30 num_records: usize,
31 ) -> Result<(), ParquetError>;
32}