link-cli 0.2.6

A CLI tool and reusable library for links manipulation backed by a LiNo-notation doublet storage engine.
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

//! Pinned type allocation compatible with the C# `PinnedTypes` helper.

use anyhow::{bail, Result};
use std::path::Path;

use crate::link::Link;
use crate::link_storage::LinkStorage;

pub trait PinnedTypesAccess {
    fn pinned_types(&mut self, count: usize) -> Result<Vec<u32>>;

    fn deconstruct_pinned_types(&mut self) -> Result<(u32, u32, u32)> {
        let pinned_types = self.pinned_types(3)?;
        Ok((pinned_types[0], pinned_types[1], pinned_types[2]))
    }
}

/// Creates or validates the reserved type links at deterministic addresses.
pub struct PinnedTypes<'a> {
    links: &'a mut LinkStorage,
    current: u32,
    initial_source: u32,
}

impl<'a> PinnedTypes<'a> {
    pub fn new(links: &'a mut LinkStorage) -> Self {
        Self {
            links,
            current: 1,
            initial_source: 1,
        }
    }

    pub fn next_type(&mut self) -> Result<u32> {
        let address = self.current;
        if let Some(link) = self.links.get(address) {
            if link.index != address || link.source != self.initial_source || link.target != address
            {
                bail!(
                    "Unexpected link found at address {address}. Expected: ({address}: {} {address}), Found: ({}: {} {}).",
                    self.initial_source,
                    link.index,
                    link.source,
                    link.target
                );
            }
        } else {
            let created = self.links.get_or_create(self.initial_source, address);
            if created != address {
                bail!(
                    "Pinned type address {address} could not be created deterministically; got {created}."
                );
            }
        }

        self.current += 1;
        Ok(address)
    }

    pub fn take_types(&mut self, count: usize) -> Result<Vec<u32>> {
        (0..count).map(|_| self.next_type()).collect()
    }

    pub fn deconstruct(&mut self) -> Result<(u32, u32, u32)> {
        let pinned_types = self.take_types(3)?;
        Ok((pinned_types[0], pinned_types[1], pinned_types[2]))
    }
}

/// Link storage decorator that exposes pinned type allocation.
pub struct PinnedTypesDecorator {
    links: LinkStorage,
}

impl PinnedTypesDecorator {
    pub fn new<P>(database_filename: P, trace: bool) -> Result<Self>
    where
        P: AsRef<Path>,
    {
        let database_path = database_filename.as_ref().to_string_lossy().into_owned();
        let links = LinkStorage::new(&database_path, trace)?;
        Ok(Self::from_link_storage(links))
    }

    pub fn from_link_storage(links: LinkStorage) -> Self {
        Self { links }
    }

    pub fn links(&self) -> &LinkStorage {
        &self.links
    }

    pub fn links_mut(&mut self) -> &mut LinkStorage {
        &mut self.links
    }

    pub fn into_link_storage(self) -> LinkStorage {
        self.links
    }

    pub fn save(&self) -> Result<()> {
        self.links.save()
    }

    pub fn create(&mut self, source: u32, target: u32) -> u32 {
        self.links.create(source, target)
    }

    pub fn ensure_created(&mut self, id: u32) -> u32 {
        self.links.ensure_created(id)
    }

    pub fn get(&self, id: u32) -> Option<&Link> {
        self.links.get(id)
    }

    pub fn exists(&self, id: u32) -> bool {
        self.links.exists(id)
    }

    pub fn update(&mut self, id: u32, source: u32, target: u32) -> Result<Link> {
        self.links.update(id, source, target)
    }

    pub fn delete(&mut self, id: u32) -> Result<Link> {
        self.links.delete(id)
    }

    pub fn all(&self) -> Vec<&Link> {
        self.links.all()
    }

    pub fn query(
        &self,
        index: Option<u32>,
        source: Option<u32>,
        target: Option<u32>,
    ) -> Vec<&Link> {
        self.links.query(index, source, target)
    }

    pub fn search(&self, source: u32, target: u32) -> Option<u32> {
        self.links.search(source, target)
    }

    pub fn get_or_create(&mut self, source: u32, target: u32) -> u32 {
        self.links.get_or_create(source, target)
    }
}

impl PinnedTypesAccess for PinnedTypesDecorator {
    fn pinned_types(&mut self, count: usize) -> Result<Vec<u32>> {
        PinnedTypes::new(&mut self.links).take_types(count)
    }
}