swh-graph 12.1.2

Compressed in-memory representation of the Software Heritage archive graph
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

// Copyright (C) 2024-2025  The Software Heritage developers
// See the AUTHORS file at the top-level directory of this distribution
// License: GNU General Public License version 3, or any later version
// See top-level LICENSE file for more information

//! Implementation of [`properties::Strings`] spy for [`GraphSpy`]

use super::*;
use properties::{OptStrings, PropertiesBackend, PropertiesResult};

impl<
        G: SwhGraphWithProperties<Strings: OptStrings>,
        MAPS: properties::MaybeMaps,
        TIMESTAMPS: properties::MaybeTimestamps,
        PERSONS: properties::MaybePersons,
        CONTENTS: properties::MaybeContents,
        LABELNAMES: properties::MaybeLabelNames,
    > GraphSpy<G, MAPS, TIMESTAMPS, PERSONS, CONTENTS, properties::NoStrings, LABELNAMES>
{
    pub fn with_strings(
        self,
    ) -> GraphSpy<G, MAPS, TIMESTAMPS, PERSONS, CONTENTS, StringsSpy<G>, LABELNAMES> {
        let GraphSpy {
            properties:
                properties::SwhGraphProperties {
                    path,
                    num_nodes,
                    maps,
                    timestamps,
                    persons,
                    contents,
                    strings: properties::NoStrings,
                    label_names,
                    label_names_are_in_base64_order,
                },
            inner,
            history,
        } = self;

        GraphSpy {
            properties: properties::SwhGraphProperties {
                path,
                num_nodes,
                maps,
                timestamps,
                persons,
                contents,
                strings: StringsSpy {
                    graph: Arc::clone(&inner),
                    history: Arc::clone(&history),
                },
                label_names,
                label_names_are_in_base64_order,
            },
            inner,
            history,
        }
    }
}

pub struct StringsSpy<G: SwhGraphWithProperties<Strings: OptStrings>> {
    graph: Arc<GraphSpyInner<G>>,
    history: Arc<Mutex<Vec<GraphAccessRecord>>>,
}

impl<G: SwhGraphWithProperties<Strings: OptStrings>> PropertiesBackend for StringsSpy<G> {
    type DataFilesAvailability =
        <<G as SwhGraphWithProperties>::Strings as PropertiesBackend>::DataFilesAvailability;
}

impl<G: SwhGraphWithProperties<Strings: OptStrings>> OptStrings for StringsSpy<G> {
    fn message(&self) -> PropertiesResult<'_, &[u8], Self> {
        // no need to log, every access necessarily calls message_offset too
        self.graph.graph.properties().strings.message()
    }

    fn message_offset(&self, node: NodeId) -> PropertiesResult<'_, Option<u64>, Self> {
        self.history
            .lock()
            .unwrap()
            .push(GraphAccessRecord::Property(PropertyAccess::Message(node)));
        self.graph.graph.properties().strings.message_offset(node)
    }

    fn tag_name(&self) -> PropertiesResult<'_, &[u8], Self> {
        // no need to log, every access necessarily call tag_name_offset too
        self.graph.graph.properties().strings.tag_name()
    }

    fn tag_name_offset(&self, node: NodeId) -> PropertiesResult<'_, Option<u64>, Self> {
        self.history
            .lock()
            .unwrap()
            .push(GraphAccessRecord::Property(PropertyAccess::TagName(node)));
        self.graph.graph.properties().strings.tag_name_offset(node)
    }
}