froe 0.10.0

Reader and offline maintenance toolkit for Apache Jackrabbit Oak segment-tar (TarMK) repositories: parse archives and records, extract node data, compact, back up, and recover.
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

//! An in-memory sink that is also a provider, so a written record can be
//! read back without a store.

use super::{RecordWriter, SegmentSink};
use crate::content::provider::SegmentProvider;
use crate::content::template::{Template, read_template};
use crate::content::value::read_string;
use crate::error::{Error, Result};
use crate::segment::identifier::SegmentIdentifier;
use crate::segment::parsed_segment::ParsedSegment;
use crate::segment::record::RecordIdentifier;
use crate::segment::view::SegmentView;
use crate::writer::segment_builder::{BuiltSegment, GarbageCollectionGeneration};
use std::collections::HashMap;
use std::sync::Arc;

/// Collects written segments and serves them back as a provider, so
/// every test reads its output through the production reader.
#[derive(Default)]
pub(crate) struct MemoryStore {
    pub(crate) segments: HashMap<SegmentIdentifier, (Arc<ParsedSegment>, Vec<u8>)>,
    pub(crate) write_order: Vec<SegmentIdentifier>,
}

impl SegmentSink for MemoryStore {
    fn write_segment(&mut self, segment: BuiltSegment) -> Result<()> {
        let parsed = Arc::new(ParsedSegment::parse(segment.identifier, &segment.bytes)?);
        self.segments
            .insert(segment.identifier, (parsed, segment.bytes));
        self.write_order.push(segment.identifier);
        Ok(())
    }
}

impl SegmentProvider for MemoryStore {
    fn segment(&self, segment_identifier: SegmentIdentifier) -> Result<SegmentView<'_>> {
        let (structure, bytes) = self
            .segments
            .get(&segment_identifier)
            .ok_or(Error::SegmentNotFound { segment_identifier })?;
        Ok(SegmentView {
            structure: Arc::clone(structure),
            bytes: bytes.as_slice().into(),
        })
    }

    fn string(&self, record_identifier: RecordIdentifier) -> Result<Arc<str>> {
        read_string(self, record_identifier).map(Arc::from)
    }

    fn template(&self, record_identifier: RecordIdentifier) -> Result<Arc<Template>> {
        read_template(self, record_identifier).map(Arc::new)
    }
}

pub(crate) fn test_generation() -> GarbageCollectionGeneration {
    GarbageCollectionGeneration {
        generation: 1,
        full_generation: 1,
        is_compacted: false,
    }
}

pub(crate) fn new_writer() -> RecordWriter<MemoryStore> {
    RecordWriter::new(MemoryStore::default(), test_generation())
}