alamb commented on code in PR #8763: URL: https://github.com/apache/arrow-rs/pull/8763#discussion_r2502999591
########## parquet/src/file/metadata/options.rs: ########## @@ -0,0 +1,108 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +//! Options used to control metadata parsing + +use crate::schema::types::SchemaDescPtr; + +/// Options that can be set to control what parts of the Parquet file footer +/// metadata will be decoded and made present in the [`ParquetMetaData`] returned +/// by [`ParquetMetaDataReader`] and [`ParquetMetaDataPushDecoder`]. +/// +/// [`ParquetMetaData`]: crate::file::metadata::ParquetMetaData +/// [`ParquetMetaDataReader`]: crate::file::metadata::ParquetMetaDataReader +/// [`ParquetMetaDataPushDecoder`]: crate::file::metadata::ParquetMetaDataPushDecoder +#[derive(Default, Debug, Clone)] +pub struct ParquetMetaDataOptions { + schema_descr: Option<SchemaDescPtr>, +} + +impl ParquetMetaDataOptions { + /// Return a new default [`ParquetMetaDataOptions`]. + pub fn new() -> Self { + Default::default() + } + + /// Returns an optional [`SchemaDescPtr`] to use when decoding. If this is not `None` then + /// the schema in the footer will be skipped. + pub fn schema(&self) -> Option<&SchemaDescPtr> { + self.schema_descr.as_ref() + } + + /// Provide a schema to use when decoding the metadata. + pub fn set_schema(&mut self, val: SchemaDescPtr) { + self.schema_descr = Some(val); + } + + /// Provide a schema to use when decoding the metadata. Returns `Self` for chaining. + pub fn with_schema(mut self, val: SchemaDescPtr) -> Self { + self.schema_descr = Some(val); + self + } +} Review Comment: > I'm going to look into a macro to cut down on the visual bloat (if not actual code bloat). I personally think it is ok to have two sets of APIs for setting things -- while it is visual bloat as you say I think the methods are so simple it is fairly easy (if repetitive) to understand While a macro might be clever I worry it would make the code that much harder to understand 🤷 -- probably a matter of opinion -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
