iscc-lib 0.4.0

High-performance Rust implementation of ISO 24138:2024 (ISCC)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! Structured result types for ISCC code generation functions.
//!
//! Each `gen_*_v0` function returns a dedicated result struct carrying the ISCC
//! code string plus any additional fields (metahash, name, characters, etc.)
//! that match the `iscc-core` Python reference implementation's dict returns.

/// Result of [`gen_meta_code_v0`](crate::gen_meta_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct MetaCodeResult {
    /// ISCC code string (e.g., `"ISCC:AAAZXZ6OU74YAZIM"`).
    pub iscc: String,
    /// Normalized name after cleaning, newline removal, and trimming.
    pub name: String,
    /// Normalized description (present only when description was non-empty).
    pub description: Option<String>,
    /// Metadata as a Data-URL string (present only when meta was provided).
    pub meta: Option<String>,
    /// Hex-encoded BLAKE3 multihash (`"1e20..."`) of the metadata payload.
    pub metahash: String,
}

/// Result of [`gen_text_code_v0`](crate::gen_text_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct TextCodeResult {
    /// ISCC code string.
    pub iscc: String,
    /// Character count after `text_collapse`.
    pub characters: usize,
}

/// Result of [`gen_image_code_v0`](crate::gen_image_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct ImageCodeResult {
    /// ISCC code string.
    pub iscc: String,
}

/// Result of [`gen_audio_code_v0`](crate::gen_audio_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct AudioCodeResult {
    /// ISCC code string.
    pub iscc: String,
}

/// Result of [`gen_video_code_v0`](crate::gen_video_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct VideoCodeResult {
    /// ISCC code string.
    pub iscc: String,
}

/// Result of [`gen_mixed_code_v0`](crate::gen_mixed_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct MixedCodeResult {
    /// ISCC code string.
    pub iscc: String,
    /// Input Content-Code strings (passed through unchanged).
    pub parts: Vec<String>,
}

/// Result of [`gen_data_code_v0`](crate::gen_data_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct DataCodeResult {
    /// ISCC code string.
    pub iscc: String,
}

/// Result of [`gen_instance_code_v0`](crate::gen_instance_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct InstanceCodeResult {
    /// ISCC code string.
    pub iscc: String,
    /// Hex-encoded BLAKE3 multihash (`"1e20..."`) of the input data.
    pub datahash: String,
    /// Byte length of the input data.
    pub filesize: u64,
}

/// Result of [`gen_iscc_code_v0`](crate::gen_iscc_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct IsccCodeResult {
    /// ISCC code string.
    pub iscc: String,
}

/// Result of [`gen_sum_code_v0`](crate::gen_sum_code_v0).
#[derive(Debug, Clone, PartialEq, Eq)]
#[non_exhaustive]
pub struct SumCodeResult {
    /// Composite ISCC-CODE string (e.g., `"ISCC:KAC..."`).
    pub iscc: String,
    /// Hex-encoded BLAKE3 multihash (`"1e20..."`) of the file.
    pub datahash: String,
    /// Byte length of the file.
    pub filesize: u64,
    /// Individual `[Data-Code, Instance-Code]` ISCC strings at the requested bit precision.
    /// Present only when `add_units` is `true`.
    pub units: Option<Vec<String>>,
}