datafusion_common/file_options/
json_writer.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
18//! Options related to how json files should be written
19
20use crate::{
21    config::JsonOptions,
22    error::{DataFusionError, Result},
23    parsers::CompressionTypeVariant,
24};
25
26/// Options for writing JSON files
27#[derive(Clone, Debug)]
28pub struct JsonWriterOptions {
29    pub compression: CompressionTypeVariant,
30    pub compression_level: Option<u32>,
31}
32
33impl JsonWriterOptions {
34    pub fn new(compression: CompressionTypeVariant) -> Self {
35        Self {
36            compression,
37            compression_level: None,
38        }
39    }
40
41    /// Create a new `JsonWriterOptions` with the specified compression and level.
42    pub fn new_with_level(
43        compression: CompressionTypeVariant,
44        compression_level: u32,
45    ) -> Self {
46        Self {
47            compression,
48            compression_level: Some(compression_level),
49        }
50    }
51}
52
53impl TryFrom<&JsonOptions> for JsonWriterOptions {
54    type Error = DataFusionError;
55
56    fn try_from(value: &JsonOptions) -> Result<Self> {
57        Ok(JsonWriterOptions {
58            compression: value.compression,
59            compression_level: value.compression_level,
60        })
61    }
62}