lix 0.18.0

Embeddable version control for apps and AI agents.
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

use std::sync::Arc;

/// A non-blocking observer for Lix open and automatic migration.
///
/// Implementations must return promptly. Progress is observational: panics
/// are isolated and cannot change whether opening succeeds.
pub trait OpenProgressSink: Send + Sync {
    fn report(&self, progress: OpenProgress);
}

/// Coarse, stable phases suitable for a CLI, loading screen, or logs.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum OpenPhase {
    Inspecting,
    Migrating,
    Validating,
    Opening,
    Complete,
}

/// Repository whose opening produced this event.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum OpenScope {
    Local,
    Authority,
}

/// One Lix-open progress snapshot.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct OpenProgress {
    pub scope: OpenScope,
    pub phase: OpenPhase,
    pub from_format: Option<u32>,
    pub to_format: u32,
    pub completed: Option<u64>,
    pub total: Option<u64>,
}

/// The migration performed by this open, if any.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct OpenMigrationReport {
    pub from_format: u32,
    pub to_format: u32,
}

/// A completed upgrade observed during opening.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct OpenMigration {
    pub scope: OpenScope,
    pub from_format: u32,
    pub to_format: u32,
}

/// Immutable facts about how this handle was opened.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct OpenReport {
    pub migrations: Vec<OpenMigration>,
    pub format: u32,
    pub initialized: bool,
    pub migration: Option<OpenMigrationReport>,
}

pub(crate) fn emit_open_progress(
    sink: Option<&Arc<dyn OpenProgressSink>>,
    progress: OpenProgress,
) {
    let Some(sink) = sink else { return };
    let sink = Arc::clone(sink);
    let _ = std::panic::catch_unwind(std::panic::AssertUnwindSafe(|| sink.report(progress)));
}