heddle-objects 0.15.1

An AI-native version control system
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

// SPDX-License-Identifier: Apache-2.0
//! Transfer planning for Heddle object lanes.
//!
//! One vocabulary for local sync, hosted sync, and the wire protocol:
//! content-addressed objects that can ride the native pack, and signed
//! sidecars that must use the out-of-pack verification paths.

pub mod availability;
pub mod graph;
pub mod plan;

pub use availability::{ObjectAvailabilityPlan, has_object, plan_object_availability};
pub use graph::{
    ObjectId, ObjectInfo, ObjectType, ObjectTypeBucket, PlannedObject, StateClosureOptions,
    StateClosureTransferObjects, enumerate_state_closure, enumerate_state_closure_plan,
    enumerate_state_closure_plan_with_options, enumerate_state_closure_transfer_from_boundaries,
    enumerate_state_closure_transfer_with_options, enumerate_state_closure_with_options,
    is_ancestor, missing_blobs_in_tree,
};
pub use plan::{
    GitLaneTransferIntent, RepositoryTransferPlan, TransferPartitions, TransferPlanStats,
};

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

    /// The push/pull packability split routes `StateAttachment` off the push
    /// pack (weft#549 forgery seal) while leaving pull carriage and every other
    /// type untouched.
    #[test]
    fn packable_predicates_split_state_attachment_by_direction() {
        // Sidecar records are never packable in either direction.
        for sidecar in [
            ObjectType::Redaction,
            ObjectType::StateVisibility,
            ObjectType::KeyBinding,
        ] {
            assert!(!sidecar.packable_for_push(), "{sidecar:?} push");
            assert!(!sidecar.packable_for_pull(), "{sidecar:?} pull");
        }
        // Content-addressed objects ride the pack in both directions.
        for packable in [
            ObjectType::Blob,
            ObjectType::Tree,
            ObjectType::State,
            ObjectType::Action,
        ] {
            assert!(packable.packable_for_push(), "{packable:?} push");
            assert!(packable.packable_for_pull(), "{packable:?} pull");
        }
        // The attachment record: excluded from the push pack, kept on pull.
        assert!(!ObjectType::StateAttachment.packable_for_push());
        assert!(ObjectType::StateAttachment.packable_for_pull());
    }
}