iceberg 0.9.0

Apache Iceberg Rust implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81

// 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.

//! Iceberg Puffin implementation.

#![deny(missing_docs)]

use crate::{Error, ErrorKind, Result};

mod blob;
pub use blob::{APACHE_DATASKETCHES_THETA_V1, Blob, DELETION_VECTOR_V1};

pub use crate::compression::CompressionCodec;

/// Compression codecs supported by the Puffin spec.
const SUPPORTED_PUFFIN_CODECS: &[CompressionCodec] = &[
    CompressionCodec::None,
    CompressionCodec::Lz4,
    CompressionCodec::Zstd,
];

/// Validates that the compression codec is supported for Puffin files.
/// Returns an error if the codec is not supported.
fn validate_puffin_compression(codec: CompressionCodec) -> Result<()> {
    if !SUPPORTED_PUFFIN_CODECS.contains(&codec) {
        let supported_names: Vec<String> = SUPPORTED_PUFFIN_CODECS
            .iter()
            .map(|c| format!("{c:?}"))
            .collect();
        return Err(Error::new(
            ErrorKind::DataInvalid,
            format!(
                "Compression codec {codec:?} is not supported for Puffin files. Only {} are supported.",
                supported_names.join(", ")
            ),
        ));
    }
    Ok(())
}

mod metadata;
pub use metadata::{BlobMetadata, CREATED_BY_PROPERTY, FileMetadata};

mod reader;
pub use reader::PuffinReader;

mod writer;
pub use writer::PuffinWriter;

#[cfg(test)]
mod test_utils;

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_puffin_codec_validation() {
        // All codecs in SUPPORTED_PUFFIN_CODECS should be valid
        for codec in SUPPORTED_PUFFIN_CODECS {
            assert!(validate_puffin_compression(*codec).is_ok());
        }

        // Gzip should not be supported for Puffin files
        assert!(validate_puffin_compression(CompressionCodec::Gzip).is_err());
    }
}