bazaar 3.5.3

Rust implementation of the Bazaar formats and protocols
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
109
110
111

//! Core dirstate record types: the `TreeData` / `EntryKey` / `Entry`
//! / `Dirblock` quartet plus the tag enums (`YesNo`, `MemoryState`,
//! `LockState`).

use super::Kind;

pub enum YesNo {
    Yes,
    No,
}

/// `_header_state` and `_dirblock_state` represent the current state
/// of the dirstate metadata and the per-row data respectively.
///
/// In future we will add more granularity — for instance
/// `_dirblock_state` will probably support partially-in-memory as a
/// separate variable, allowing for partially-in-memory unmodified
/// and partially-in-memory modified states.
#[derive(PartialEq, Eq, Debug, Clone, Copy)]
pub enum MemoryState {
    /// No data is in memory.
    NotInMemory,
    /// What we have in memory is the same as what is on disk.
    InMemoryUnmodified,
    /// We have a modified version of what is on disk.
    InMemoryModified,
    InMemoryHashModified,
}

/// Sentinel `packed_stat` value used when no real stat is cached for
/// an entry — 32 ASCII `x` characters, distinct from any base64
/// encoding of an actual stat tuple.
pub const NULLSTAT: &[u8] = b"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";

/// `(minikind, fingerprint, size, executable, packed_stat)` tuple
/// reserved for absent parent slots in the dirblock format.
pub fn null_parent_details() -> TreeData {
    TreeData {
        minikind: Kind::Absent,
        fingerprint: Vec::new(),
        size: 0,
        executable: false,
        packed_stat: Vec::new(),
    }
}

/// Per-tree record attached to an entry: `(minikind, fingerprint, size, executable, packed_stat)`.
///
/// Mirrors the 5-tuple stored at `entry[1][tree_index]` in the Python
/// `DirState`. `fingerprint` is the sha1 for files, the link target
/// for symlinks, or the parent revision for tree references; `size`
/// is the file size in bytes (0 for non-files); `packed_stat` is the
/// base64 `pack_stat` string, or `DirState.NULLSTAT` when no stat is
/// cached.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct TreeData {
    pub minikind: Kind,
    pub fingerprint: Vec<u8>,
    pub size: u64,
    pub executable: bool,
    pub packed_stat: Vec<u8>,
}

/// The `(dirname, basename, file_id)` triple that keys a dirstate entry.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub struct EntryKey {
    pub dirname: Vec<u8>,
    pub basename: Vec<u8>,
    pub file_id: Vec<u8>,
}

/// A single dirstate entry: a key plus one `TreeData` per tracked tree
/// (current tree followed by present parent trees).
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Entry {
    pub key: EntryKey,
    pub trees: Vec<TreeData>,
}

impl Entry {
    /// Minikind of the slot at `tree_index`, or `None` when the
    /// entry has fewer tree slots than that index.
    #[inline]
    pub fn tree_kind(&self, tree_index: usize) -> Option<Kind> {
        self.trees.get(tree_index).map(|t| t.minikind)
    }

    /// Minikind of the current (tree-0) slot.  Shorthand for
    /// ``entry.tree_kind(0)``.
    #[inline]
    pub fn tree0_kind(&self) -> Option<Kind> {
        self.tree_kind(0)
    }
}

/// A directory block: all entries whose `dirname` equals `dirname`, in sort
/// order. Mirrors the `(dirname, [entry, ...])` tuple Python stores in
/// `DirState._dirblocks`.
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct Dirblock {
    pub dirname: Vec<u8>,
    pub entries: Vec<Entry>,
}

/// Whether a dirstate is currently locked for read or write, matching the
/// `_lock_state` string Python stores (`"r"`, `"w"`, or `None`).
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum LockState {
    Read,
    Write,
}