zarrs 0.22.4

A library for the Zarr storage format for multidimensional arrays and metadata
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

//! `zarrs` version information.

include!(concat!(env!("OUT_DIR"), "/version.rs"));

/// The `zarrs` major version.
#[must_use]
pub const fn version_major() -> u32 {
    VERSION_MAJOR
}

/// The `zarrs` minor version.
#[must_use]
pub const fn version_minor() -> u32 {
    VERSION_MINOR
}

/// The `zarrs` patch version.
#[must_use]
pub const fn version_patch() -> u32 {
    VERSION_PATCH
}

/// The `zarrs` pre-release version.
#[must_use]
pub const fn version_pre() -> &'static str {
    env!("CARGO_PKG_VERSION_PRE")
}

/// A [`u32`] representation of the `zarrs` version.
///
/// Encoded as
/// ```rust
/// # use zarrs::version::version_major;
/// # use zarrs::version::version_minor;
/// # use zarrs::version::version_patch;
/// let version =
///     (version_major() << 22) | (version_minor() << 12) | version_patch();
/// ```
/// The major/minor/patch version can then be decoded as
/// ```rust
/// # use zarrs::version::version_major;
/// # use zarrs::version::version_minor;
/// # use zarrs::version::version_patch;
/// # let version = (version_major() << 22) | (version_minor() << 12) | version_patch();
/// # assert!(version == zarrs::version::version());
/// let version_major = (version as u32 >> 22) & 0x7F;
/// # assert!(version_major == zarrs::version::version_major());
/// let version_minor = (version as u32 >> 12) & 0x3FF;
/// # assert!(version_minor == zarrs::version::version_minor());
/// let version_patch = (version as u32) & 0xFFF;
/// # assert!(version_patch == zarrs::version::version_patch());
/// ```
#[must_use]
pub const fn version() -> u32 {
    (version_major() << 22) | (version_minor() << 12) | version_patch()
}

/// A string representation of the `zarrs` version.
///
/// Matches the `CARGO_PKG_VERSION`.
#[must_use]
pub const fn version_str() -> &'static str {
    env!("CARGO_PKG_VERSION")
}