padzapp 0.20.0

An ergonomic, context-aware scratch pad library with plain text storage
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

use crate::error::Result;
use crate::model::{Metadata, Scope};
use crate::tags::TagEntry;
use chrono::{DateTime, Utc};
use std::collections::HashMap;
use std::path::PathBuf;
use uuid::Uuid;

/// Abstract interface for raw storage I/O.
/// This trait handles the "how" of storage (filesystem vs memory),
/// while PadStore handles the "what" (business logic, sync, doctor).
pub trait StorageBackend {
    // --- Index Operations ---

    /// Load the metadata index (data.json)
    fn load_index(&self, scope: Scope) -> Result<HashMap<Uuid, Metadata>>;

    /// Save the metadata index
    fn save_index(&self, scope: Scope, index: &HashMap<Uuid, Metadata>) -> Result<()>;

    // --- Tag Registry Operations ---

    /// Load the tag registry (tags.json)
    fn load_tags(&self, scope: Scope) -> Result<Vec<TagEntry>>;

    /// Save the tag registry
    fn save_tags(&self, scope: Scope, tags: &[TagEntry]) -> Result<()>;

    // --- Content Operations ---

    /// Read raw content string for a pad.
    /// Returns Ok(None) if the file does not exist (useful for zombie detection).
    /// Returns Err only on actual I/O errors (permissions, disk failure).
    fn read_content(&self, id: &Uuid, scope: Scope) -> Result<Option<String>>;

    /// Write content to storage.
    /// MUST be atomic (e.g. write to tmp then rename) to avoid partial writes.
    fn write_content(&self, id: &Uuid, scope: Scope, content: &str) -> Result<()>;

    /// Delete content file.
    fn delete_content(&self, id: &Uuid, scope: Scope) -> Result<()>;

    // --- Discovery & Metadata ---

    /// List all content IDs found in storage (for sync/reconciliation).
    fn list_content_ids(&self, scope: Scope) -> Result<Vec<Uuid>>;

    /// Get modification time of the content file.
    fn content_mtime(&self, id: &Uuid, scope: Scope) -> Result<Option<DateTime<Utc>>>;

    // --- Paths & Capabilities ---

    /// Get the "file path" for the content.
    /// For FsBackend, this is the real path. For MemBackend, a virtual path.
    /// Returns Err if the scope is not available.
    fn content_path(&self, id: &Uuid, scope: Scope) -> Result<PathBuf>;

    /// Check if a scope is available (e.g. project root exists).
    fn scope_available(&self, scope: Scope) -> bool;
}