icechunk_format/
lib.rs

1//! Icechunk data types and serialization.
2//!
3//! Defines ID types ([`SnapshotId`], [`ManifestId`], [`ChunkId`], [`NodeId`]),
4//! [`Path`] for normalized Zarr paths, and [`ByteRange`]/[`ChunkIndices`] for
5//! chunk addressing. Submodules define snapshots, manifests, and transaction logs.
6
7use core::fmt;
8use std::{
9    cmp::Ordering,
10    convert::Infallible,
11    fmt::{Debug, Display},
12    hash::Hash,
13    marker::PhantomData,
14    ops::Range,
15};
16
17use ::flatbuffers::InvalidFlatbuffer;
18use bytes::Bytes;
19use chrono::{DateTime, Utc};
20use flatbuffers::generated;
21use format_constants::FileTypeBin;
22use manifest::VirtualReferenceErrorKind;
23use rand::{RngExt as _, rng};
24use serde::{Deserialize, Serialize};
25use thiserror::Error;
26
27use icechunk_types::error::ICError;
28use icechunk_types::sealed;
29
30/// User attributes stored on arrays and groups.
31pub mod attributes;
32/// Chunk reference tables.
33pub mod manifest;
34
35/// Generated Flatbuffer types for binary serialization.
36#[path = "./flatbuffers/all_generated.rs"]
37#[allow(clippy::all, warnings)]
38pub mod flatbuffers;
39
40/// Repository metadata (version, properties).
41pub mod repo_info;
42/// Flatbuffer serialization.
43pub mod serializers;
44/// Repository state at a point in time.
45pub mod snapshot;
46/// Change records for commits.
47pub mod transaction_log;
48
49pub const CONFIG_FILE_PATH: &str = "config.yaml";
50pub const REPO_INFO_FILE_PATH: &str = "repo";
51pub const CHUNKS_FILE_PATH: &str = "chunks";
52pub const MANIFESTS_FILE_PATH: &str = "manifests";
53pub const SNAPSHOTS_FILE_PATH: &str = "snapshots";
54pub const TRANSACTION_LOGS_FILE_PATH: &str = "transactions";
55pub const OVERWRITTEN_FILES_PATH: &str = "overwritten";
56pub const V1_REFS_FILE_PATH: &str = "refs";
57
58pub use icechunk_types::{Path, PathError};
59
60/// Marker trait for object ID type tags (sealed).
61pub trait FileTypeTag: sealed::Sealed {}
62
63/// The id of a file in object store
64#[derive(Hash, Clone, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
65pub struct ObjectId<const SIZE: usize, T: FileTypeTag>(
66    #[serde(with = "serde_bytes")] pub [u8; SIZE],
67    PhantomData<T>,
68);
69
70/// Type tag for [`SnapshotId`].
71#[derive(Debug, Hash, Clone, PartialEq, Eq, PartialOrd, Ord)]
72pub struct SnapshotTag;
73
74/// Type tag for [`ManifestId`].
75#[derive(Debug, Hash, Clone, PartialEq, Eq, PartialOrd, Ord)]
76pub struct ManifestTag;
77
78/// Type tag for [`ChunkId`].
79#[derive(Debug, Hash, Clone, PartialEq, Eq, PartialOrd, Ord)]
80pub struct ChunkTag;
81
82/// Type tag for [`AttributesId`].
83#[derive(Debug, Hash, Clone, PartialEq, Eq, PartialOrd, Ord)]
84pub struct AttributesTag;
85
86/// Type tag for [`NodeId`].
87#[derive(Debug, Hash, Clone, PartialEq, Eq, PartialOrd, Ord)]
88pub struct NodeTag;
89
90impl sealed::Sealed for SnapshotTag {}
91impl sealed::Sealed for ManifestTag {}
92impl sealed::Sealed for ChunkTag {}
93impl sealed::Sealed for AttributesTag {}
94impl sealed::Sealed for NodeTag {}
95impl FileTypeTag for SnapshotTag {}
96impl FileTypeTag for ManifestTag {}
97impl FileTypeTag for ChunkTag {}
98impl FileTypeTag for AttributesTag {}
99impl FileTypeTag for NodeTag {}
100
101// A 1e-9 conflict probability requires 2^33 ~ 8.5 bn chunks
102// using this site for the calculations: https://www.bdayprob.com/
103
104/// Unique identifier for a snapshot.
105pub type SnapshotId = ObjectId<12, SnapshotTag>;
106/// Unique identifier for a manifest file.
107pub type ManifestId = ObjectId<12, ManifestTag>;
108/// Unique identifier for a chunk.
109pub type ChunkId = ObjectId<12, ChunkTag>;
110/// Unique identifier for an attributes blob.
111pub type AttributesId = ObjectId<12, AttributesTag>;
112
113// A 1e-9 conflict probability requires 2^17.55 ~ 200k nodes
114/// The internal id of an array or group, unique only to a single store version
115pub type NodeId = ObjectId<8, NodeTag>;
116
117#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Hash)]
118pub enum NodeType {
119    Group,
120    Array,
121}
122
123#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Hash)]
124pub struct Move {
125    pub from: Path,
126    pub to: Path,
127    pub node_id: NodeId,
128    pub node_type: NodeType,
129}
130
131impl From<NodeType> for generated::NodeType {
132    fn from(value: NodeType) -> Self {
133        match value {
134            NodeType::Group => generated::NodeType::Group,
135            NodeType::Array => generated::NodeType::Array,
136        }
137    }
138}
139
140impl NodeType {
141    fn max_supported() -> u8 {
142        generated::NodeType::ENUM_MAX
143    }
144}
145
146impl TryFrom<generated::NodeType> for NodeType {
147    type Error = IcechunkFormatErrorKind;
148
149    fn try_from(value: generated::NodeType) -> Result<Self, Self::Error> {
150        match value {
151            generated::NodeType::Group => Ok(NodeType::Group),
152            generated::NodeType::Array => Ok(NodeType::Array),
153            generated::NodeType(v) => Err(IcechunkFormatErrorKind::InvalidNodeType {
154                found: v,
155                max_supported: Self::max_supported(),
156            }),
157        }
158    }
159}
160
161impl<const SIZE: usize, T: FileTypeTag> ObjectId<SIZE, T> {
162    pub fn random() -> Self {
163        let mut buf = [0u8; SIZE];
164        rng().fill(&mut buf[..]);
165        Self(buf, PhantomData)
166    }
167
168    pub const fn new(buf: [u8; SIZE]) -> Self {
169        Self(buf, PhantomData)
170    }
171
172    pub const FAKE: Self = Self([0; SIZE], PhantomData);
173}
174
175impl<const SIZE: usize, T: FileTypeTag> Debug for ObjectId<SIZE, T> {
176    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
177        write!(f, "{}", String::from(self))
178    }
179}
180
181impl<const SIZE: usize, T: FileTypeTag> TryFrom<&[u8]> for ObjectId<SIZE, T> {
182    type Error = &'static str;
183
184    fn try_from(value: &[u8]) -> Result<Self, Self::Error> {
185        let buf = value.try_into();
186        buf.map(|buf| ObjectId(buf, PhantomData))
187            .map_err(|_| "Invalid ObjectId buffer length")
188    }
189}
190
191impl<const SIZE: usize, T: FileTypeTag> TryFrom<&str> for ObjectId<SIZE, T> {
192    type Error = &'static str;
193
194    fn try_from(value: &str) -> Result<Self, Self::Error> {
195        let bytes = base32::decode(base32::Alphabet::Crockford, value);
196        let Some(bytes) = bytes else { return Err("Invalid ObjectId string") };
197        Self::try_from(bytes.as_slice())
198    }
199}
200
201impl<const SIZE: usize, T: FileTypeTag> From<&ObjectId<SIZE, T>> for String {
202    fn from(value: &ObjectId<SIZE, T>) -> Self {
203        base32::encode(base32::Alphabet::Crockford, &value.0)
204    }
205}
206
207impl<const SIZE: usize, T: FileTypeTag> From<[u8; SIZE]> for ObjectId<SIZE, T> {
208    fn from(value: [u8; SIZE]) -> Self {
209        ObjectId::new(value)
210    }
211}
212
213impl<const SIZE: usize, T: FileTypeTag> TryInto<String> for ObjectId<SIZE, T> {
214    type Error = Infallible;
215
216    fn try_into(self) -> Result<String, Self::Error> {
217        Ok(self.to_string())
218    }
219}
220
221impl<const SIZE: usize, T: FileTypeTag> TryInto<ObjectId<SIZE, T>> for String {
222    type Error = &'static str;
223
224    fn try_into(self) -> Result<ObjectId<SIZE, T>, Self::Error> {
225        self.as_str().try_into()
226    }
227}
228
229impl<const SIZE: usize, T: FileTypeTag> Display for ObjectId<SIZE, T> {
230    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
231        write!(f, "{}", String::from(self))
232    }
233}
234
235/// An ND index to an element in a chunk grid.
236#[derive(Clone, Debug, Hash, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
237pub struct ChunkIndices(pub Vec<u32>);
238
239/// Byte offset within a chunk.
240pub type ChunkOffset = u64;
241/// Size of a chunk in bytes.
242pub type ChunkLength = u64;
243
244impl<'a> From<generated::ChunkIndices<'a>> for ChunkIndices {
245    fn from(value: generated::ChunkIndices<'a>) -> Self {
246        ChunkIndices(value.coords().iter().collect())
247    }
248}
249
250/// A byte range within a chunk or object.
251#[derive(Debug, Clone, PartialEq, Eq, Hash)]
252pub enum ByteRange {
253    /// The fixed length range represented by the given `Range`
254    Bounded(Range<ChunkOffset>),
255    /// All bytes from the given offset (included) to the end of the object
256    From(ChunkOffset),
257    /// The last n bytes in the object
258    Last(ChunkLength),
259    /// All bytes up to the last n bytes in the object
260    Until(ChunkOffset),
261}
262
263impl From<Range<ChunkOffset>> for ByteRange {
264    fn from(value: Range<ChunkOffset>) -> Self {
265        ByteRange::Bounded(value)
266    }
267}
268
269impl ByteRange {
270    pub fn from_offset(offset: ChunkOffset) -> Self {
271        Self::From(offset)
272    }
273
274    pub fn from_offset_with_length(offset: ChunkOffset, length: ChunkOffset) -> Self {
275        Self::Bounded(offset..offset + length)
276    }
277
278    pub fn to_offset(offset: ChunkOffset) -> Self {
279        Self::Bounded(0..offset)
280    }
281
282    pub fn bounded(start: ChunkOffset, end: ChunkOffset) -> Self {
283        (start..end).into()
284    }
285
286    pub const ALL: Self = Self::From(0);
287
288    pub fn slice(&self, bytes: &Bytes) -> Bytes {
289        match self {
290            ByteRange::Bounded(range) => {
291                bytes.slice(range.start as usize..range.end as usize)
292            }
293            ByteRange::From(from) => bytes.slice(*from as usize..),
294            ByteRange::Last(n) => bytes.slice(bytes.len() - *n as usize..),
295            ByteRange::Until(n) => bytes.slice(0usize..bytes.len() - *n as usize),
296        }
297    }
298}
299
300impl From<(Option<ChunkOffset>, Option<ChunkOffset>)> for ByteRange {
301    fn from((start, end): (Option<ChunkOffset>, Option<ChunkOffset>)) -> Self {
302        match (start, end) {
303            (Some(start), Some(end)) => Self::Bounded(start..end),
304            (Some(start), None) => Self::From(start),
305            // NOTE: This is relied upon by zarr python
306            (None, Some(end)) => Self::Until(end),
307            (None, None) => Self::ALL,
308        }
309    }
310}
311
312/// Offset within a manifest table.
313pub type TableOffset = u32;
314
315/// Format-level error types.
316#[derive(Debug, Error)]
317#[non_exhaustive]
318pub enum IcechunkFormatErrorKind {
319    #[error(transparent)]
320    VirtualReferenceError(#[from] VirtualReferenceErrorKind),
321    #[error("node not found at `{path:?}`")]
322    NodeNotFound { path: Path },
323    #[error("chunk coordinates not found `{coords:?}`")]
324    ChunkCoordinatesNotFound { coords: ChunkIndices },
325    #[error("snapshot id not found `{snapshot_id}`")]
326    SnapshotIdNotFound { snapshot_id: SnapshotId },
327    #[error("branch already exists `{branch} -> {snapshot_id}`")]
328    BranchAlreadyExists { branch: String, snapshot_id: SnapshotId },
329    #[error("branch not found `{branch}`")]
330    BranchNotFound { branch: String },
331    #[error("tag already exists `{tag}`")]
332    TagAlreadyExists { tag: String },
333    #[error("icechunk does not allow tag reuse and tag was already deleted `{tag}`")]
334    TagPreviouslyDeleted { tag: String },
335    #[error("tag not found `{tag}`")]
336    TagNotFound { tag: String },
337    #[error("snapshot id is already present in the repository: `{snapshot_id}`")]
338    DuplicateSnapshotId { snapshot_id: SnapshotId },
339    #[error("manifest information cannot be found in snapshot for id `{manifest_id}`")]
340    ManifestInfoNotFound { manifest_id: ManifestId },
341    #[error("invalid magic numbers in file")]
342    InvalidMagicNumbers, // TODO: add more info
343    #[error("invalid node type {found}, max supported value is {max_supported}")]
344    InvalidNodeType { found: u8, max_supported: u8 },
345    #[error(
346        "this repository uses Icechunk format version {found}, but this library only supports up to version {max_supported}. Please upgrade the icechunk library"
347    )]
348    InvalidSpecVersion { found: u8, max_supported: u8 },
349    #[error("this operation is not supported for Icechunk format version {version}")]
350    UnsupportedOperationForVersion { version: u8 },
351    #[error("Icechunk cannot read this file type, expected {expected:?} got {got}")]
352    InvalidFileType { expected: FileTypeBin, got: u8 }, // TODO: add more info
353    #[error("Icechunk cannot read file, invalid compression algorithm")]
354    InvalidCompressionAlgorithm, // TODO: add more info
355    #[error("Invalid Icechunk metadata file")]
356    InvalidFlatBuffer(#[from] InvalidFlatbuffer),
357    #[error("error during metadata deserialization")]
358    DeserializationError(#[from] Box<rmp_serde::decode::Error>),
359    #[error("error during metadata serialization")]
360    SerializationError(#[from] Box<rmp_serde::encode::Error>),
361    #[error("error during metadata serialization")]
362    SerializationErrorFlexBuffers(#[from] Box<flexbuffers::SerializationError>),
363    #[error("error during metadata deserialization")]
364    DeserializationErrorFlexBuffers(#[from] Box<flexbuffers::DeserializationError>),
365    #[error("I/O error")]
366    IO(#[from] std::io::Error),
367    #[error("path error")]
368    Path(#[from] PathError),
369    #[error("invalid timestamp in file")]
370    InvalidTimestamp,
371    #[error(
372        "update timestamp is invalid, please verify if the machine clock has drifted: update time: `{new_time}`, latest update time: `{latest_time}`"
373    )]
374    InvalidUpdateTimestamp { latest_time: DateTime<Utc>, new_time: DateTime<Utc> },
375    #[error("invalid feature flag name: {name}")]
376    InvalidFeatureFlagName { name: String },
377    #[error("invalid feature flag id: {id}")]
378    InvalidFeatureFlagId { id: u16 },
379    #[error("{feature_description} is disabled by a feature flag ({feature_flag})")]
380    FeatureFlagDisabled { feature_description: String, feature_flag: String },
381    #[error(
382        "compressed chunk location present but no decompression dictionary available"
383    )]
384    MissingLocationCompressionDictionary,
385    #[error("Invalid array metadata: {0}")]
386    InvalidArrayMetadata(String),
387    #[error("Move operation missing required field '{0}'")]
388    MissingRequiredField(String),
389}
390
391pub type IcechunkFormatError = ICError<IcechunkFormatErrorKind>;
392
393impl From<Infallible> for IcechunkFormatErrorKind {
394    fn from(value: Infallible) -> Self {
395        match value {}
396    }
397}
398
399pub type IcechunkResult<T> = Result<T, IcechunkFormatError>;
400
401/// Binary format constants (file types, spec versions, compression).
402pub mod format_constants {
403    use std::sync::LazyLock;
404
405    use serde::{Deserialize, Serialize};
406
407    use super::IcechunkFormatErrorKind;
408
409    /// Binary file type identifier in the file header.
410    #[repr(u8)]
411    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
412    pub enum FileTypeBin {
413        Snapshot = 1u8,
414        Manifest = 2,
415        Attributes = 3,
416        TransactionLog = 4,
417        Chunk = 5,
418        RepoInfo = 6,
419    }
420
421    impl TryFrom<u8> for FileTypeBin {
422        type Error = String;
423
424        fn try_from(value: u8) -> Result<Self, Self::Error> {
425            match value {
426                n if n == FileTypeBin::Snapshot as u8 => Ok(FileTypeBin::Snapshot),
427                n if n == FileTypeBin::Manifest as u8 => Ok(FileTypeBin::Manifest),
428                n if n == FileTypeBin::Attributes as u8 => Ok(FileTypeBin::Attributes),
429                n if n == FileTypeBin::RepoInfo as u8 => Ok(FileTypeBin::RepoInfo),
430                n if n == FileTypeBin::TransactionLog as u8 => {
431                    Ok(FileTypeBin::TransactionLog)
432                }
433                n if n == FileTypeBin::Chunk as u8 => Ok(FileTypeBin::Chunk),
434                n => Err(format!("Bad file type code: {n}")),
435            }
436        }
437    }
438
439    /// Icechunk format specification version.
440    #[repr(u8)]
441    #[derive(
442        Debug,
443        Clone,
444        Copy,
445        PartialEq,
446        Eq,
447        Serialize,
448        Deserialize,
449        Default,
450        PartialOrd,
451        Ord,
452    )]
453    pub enum SpecVersionBin {
454        V1 = 1u8,
455        #[default]
456        V2 = 2u8,
457        // When adding new versions here, don't forget to update the
458        // PySpecVersion enum in icechunk-python/src/repository.rs too!
459    }
460
461    impl TryFrom<u8> for SpecVersionBin {
462        type Error = IcechunkFormatErrorKind;
463
464        fn try_from(value: u8) -> Result<Self, Self::Error> {
465            match value {
466                n if n == SpecVersionBin::V1 as u8 => Ok(SpecVersionBin::V1),
467                n if n == SpecVersionBin::V2 as u8 => Ok(SpecVersionBin::V2),
468                n => Err(IcechunkFormatErrorKind::InvalidSpecVersion {
469                    found: n,
470                    max_supported: Self::current() as u8,
471                }),
472            }
473        }
474    }
475
476    impl SpecVersionBin {
477        pub fn current() -> Self {
478            Default::default()
479        }
480    }
481
482    impl std::fmt::Display for SpecVersionBin {
483        fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
484            let s = match self {
485                SpecVersionBin::V1 => "1.0",
486                SpecVersionBin::V2 => "2.0",
487            };
488            write!(f, "{s}")
489        }
490    }
491
492    /// Compression algorithm used for metadata files.
493    #[repr(u8)]
494    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
495    pub enum CompressionAlgorithmBin {
496        None = 0u8,
497        Zstd = 1u8,
498    }
499
500    impl TryFrom<u8> for CompressionAlgorithmBin {
501        type Error = String;
502
503        fn try_from(value: u8) -> Result<Self, Self::Error> {
504            match value {
505                n if n == CompressionAlgorithmBin::None as u8 => {
506                    Ok(CompressionAlgorithmBin::None)
507                }
508                n if n == CompressionAlgorithmBin::Zstd as u8 => {
509                    Ok(CompressionAlgorithmBin::Zstd)
510                }
511                n => Err(format!("Bad cmpression algorithm code: {n}")),
512            }
513        }
514    }
515
516    pub const ICECHUNK_FORMAT_MAGIC_BYTES: &[u8] = "ICE🧊CHUNK".as_bytes();
517
518    pub const LATEST_ICECHUNK_FORMAT_VERSION_METADATA_KEY: &str = "ic_spec_ver";
519
520    pub const ICECHUNK_LIB_VERSION: &str = env!("CARGO_PKG_VERSION");
521
522    pub static ICECHUNK_CLIENT_NAME: LazyLock<String> =
523        LazyLock::new(|| "ic-".to_string() + ICECHUNK_LIB_VERSION);
524    pub const ICECHUNK_CLIENT_NAME_METADATA_KEY: &str = "ic_client";
525
526    pub const ICECHUNK_FILE_TYPE_SNAPSHOT: &str = "snapshot";
527    pub const ICECHUNK_FILE_TYPE_MANIFEST: &str = "manifest";
528    pub const ICECHUNK_FILE_TYPE_TRANSACTION_LOG: &str = "transaction-log";
529    pub const ICECHUNK_FILE_TYPE_REPO_INFO: &str = "repo-info";
530    pub const ICECHUNK_FILE_TYPE_METADATA_KEY: &str = "ic_file_type";
531
532    pub const ICECHUNK_COMPRESSION_METADATA_KEY: &str = "ic_comp_alg";
533    pub const ICECHUNK_COMPRESSION_ZSTD: &str = "zstd";
534}
535
536#[inline(always)]
537#[expect(clippy::needless_pass_by_value)]
538pub fn lookup_index_by_key<'a, T: ::flatbuffers::Follow<'a> + 'a, K: Ord>(
539    v: ::flatbuffers::Vector<'a, T>,
540    key: K,
541    f: fn(&<T as ::flatbuffers::Follow<'a>>::Inner, &K) -> Ordering,
542) -> Option<usize> {
543    if v.is_empty() {
544        return None;
545    }
546
547    let mut left: usize = 0;
548    let mut right = v.len() - 1;
549
550    while left <= right {
551        let mid = (left + right) / 2;
552        let value = v.get(mid);
553        match f(&value, &key) {
554            Ordering::Equal => return Some(mid),
555            Ordering::Less => left = mid + 1,
556            Ordering::Greater => {
557                if mid == 0 {
558                    return None;
559                }
560                right = mid - 1;
561            }
562        }
563    }
564
565    None
566}
567
568// This macro is used for creating property tests
569// which check that serializing and deserializing
570// an instance of a type T is equivalent to the
571// identity function
572// Given pairs of test names and arbitraries to be used
573// for the tests, e.g., (n1, a1), (n2, a2),... (nx, ax)
574// the tests can be created by doing
575// roundtrip_serialization_tests!(n1 - a1, n2 - a2, .... nx - ax)
576#[macro_export]
577macro_rules! roundtrip_serialization_tests {
578    ($($test_name: ident - $generator: ident), +) => {
579        $(
580            proptest!{
581                #[icechunk_macros::test]
582                fn $test_name(elem in $generator()) {
583                    let bytes = rmp_serde::to_vec(&elem).unwrap();
584                    let roundtrip = rmp_serde::from_slice(&bytes).unwrap();
585                    assert_eq!(elem, roundtrip);
586                }
587            }
588        )*
589    }
590}
591
592#[cfg(test)]
593pub mod strategies;
594
595#[cfg(test)]
596mod tests {
597    use super::*;
598    use crate::strategies::{attributes_id, spec_version};
599    use pretty_assertions::assert_eq;
600    use proptest::prelude::*;
601
602    roundtrip_serialization_tests!(
603        serialize_and_deserialize_attribute_ids - attributes_id,
604        serialize_and_deserialize_spec_version_bin - spec_version
605    );
606
607    #[icechunk_macros::test]
608    fn test_object_id_serialization() {
609        let sid = SnapshotId::new([0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]);
610        assert_eq!(
611            serde_json::to_string(&sid).unwrap(),
612            r#"[[0,1,2,3,4,5,6,7,8,9,10,11],null]"#
613        );
614        assert_eq!(String::from(&sid), "000G40R40M30E209185G");
615        assert_eq!(sid, SnapshotId::try_from("000G40R40M30E209185G").unwrap());
616        let sid = SnapshotId::random();
617        assert_eq!(
618            serde_json::from_slice::<SnapshotId>(
619                serde_json::to_vec(&sid).unwrap().as_slice()
620            )
621            .unwrap(),
622            sid,
623        );
624    }
625
626    #[icechunk_macros::test]
627    fn test_unknown_spec_version_gives_nice_error() {
628        use format_constants::SpecVersionBin;
629
630        let future_version: u8 = 3;
631        let result = SpecVersionBin::try_from(future_version);
632        assert!(result.is_err());
633        let err = result.unwrap_err();
634
635        let msg = err.to_string();
636        assert!(
637            msg.contains("format version 3"),
638            "Error should mention the found version: {msg}"
639        );
640        assert!(
641            msg.contains("upgrade the icechunk library"),
642            "Error should suggest upgrading: {msg}"
643        );
644    }
645}
icechunk_format/lib.rs

icechunk_format/
lib.rs
