icydb-core 0.98.1

IcyDB — A schema-first typed query engine and persistence runtime for Internet Computer canisters
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

//! Module: data::persisted_row
//! Responsibility: slot-oriented persisted-row seams over runtime row bytes.
//! Does not own: row envelope versions, typed entity materialization, or query semantics.
//! Boundary: commit/index planning, row writes, and typed materialization all
//! consume the canonical slot-oriented persisted-row boundary here.

mod codec;
mod contract;
mod patch;
mod reader;
mod types;
mod writer;

#[cfg(test)]
pub(in crate::db::data::persisted_row) use contract::decode_slot_value_by_contract;
#[cfg(test)]
pub(in crate::db::data::persisted_row) use contract::decode_slot_value_from_bytes;
#[cfg(test)]
pub(in crate::db::data::persisted_row) use contract::encode_slot_payload_from_parts;
#[cfg(test)]
pub(in crate::db::data::persisted_row) use contract::encode_slot_value_from_value;
#[cfg(test)]
pub(in crate::db) use patch::apply_update_patch_to_raw_row;
#[cfg(test)]
pub(in crate::db::data::persisted_row) use patch::canonical_row_from_raw_row;
pub(in crate::db) use patch::{
    apply_serialized_update_patch_to_raw_row, canonical_row_from_complete_serialized_update_patch,
    canonical_row_from_entity, canonical_row_from_stored_raw_row,
    canonical_row_from_structural_slot_reader, materialize_entity_from_serialized_update_patch,
    serialize_entity_slots_as_complete_serialized_patch, serialize_update_patch_fields,
};
#[cfg(test)]
pub(in crate::db::data::persisted_row) use reader::CachedSlotValue;
#[cfg(feature = "diagnostics")]
pub use reader::{StructuralReadMetrics, with_structural_read_metrics};
#[cfg(all(test, not(feature = "diagnostics")))]
pub(crate) use reader::{StructuralReadMetrics, with_structural_read_metrics};
pub(in crate::db) use reader::{
    StructuralSlotReader, decode_dense_raw_row_with_contract,
    decode_sparse_indexed_raw_row_with_contract, decode_sparse_raw_row_with_contract,
    decode_sparse_required_slot_with_contract,
    decode_sparse_required_slot_with_contract_and_fields,
};
#[cfg(test)]
pub(in crate::db::data::persisted_row) use types::FieldSlot;
pub(in crate::db) use types::{CanonicalSlotReader, SerializedUpdatePatch};
pub use types::{PersistedRow, SlotReader, SlotWriter, UpdatePatch};
#[cfg(test)]
pub(in crate::db::data::persisted_row) use writer::{
    CompleteSerializedPatchWriter, SlotBufferWriter,
};

#[cfg(test)]
pub(in crate::db::data::persisted_row) use codec::encode_scalar_slot_value;
pub use codec::{
    PersistedScalar, ScalarSlotValueRef, ScalarValueRef, decode_persisted_custom_many_slot_payload,
    decode_persisted_custom_slot_payload, decode_persisted_non_null_slot_payload_by_kind,
    decode_persisted_option_scalar_slot_payload, decode_persisted_option_slot_payload_by_kind,
    decode_persisted_option_slot_payload_by_meta, decode_persisted_scalar_slot_payload,
    decode_persisted_slot_payload_by_kind, decode_persisted_slot_payload_by_meta,
    encode_persisted_custom_many_slot_payload, encode_persisted_custom_slot_payload,
    encode_persisted_option_scalar_slot_payload, encode_persisted_option_slot_payload_by_meta,
    encode_persisted_scalar_slot_payload, encode_persisted_slot_payload_by_kind,
    encode_persisted_slot_payload_by_meta,
};
#[cfg(test)]
pub(in crate::db::data::persisted_row) use types::SerializedFieldUpdate;

///
/// TESTS
///

#[cfg(test)]
mod tests;