xmpkit 0.1.3

Pure Rust implementation of Adobe XMP Toolkit
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

//! Root node abstraction for thread-safe access
//!
//! This module provides type aliases and helper methods that abstract over
//! single-threaded (Rc<RefCell<>>) and multi-threaded (Arc<RwLock<>>) implementations.

use crate::core::node::StructureNode;

#[cfg(not(feature = "mutli-thread"))]
mod impl_ {
    use super::StructureNode;
    use std::cell::{Ref, RefCell, RefMut};
    use std::rc::Rc;

    /// Single-threaded root node type (zero-cost abstraction)
    pub type RootNode = Rc<RefCell<StructureNode>>;

    /// Create a new root node
    pub fn new_root_node(node: StructureNode) -> RootNode {
        Rc::new(RefCell::new(node))
    }

    /// Read guard for root node
    pub type RootReadGuard<'a> = Ref<'a, StructureNode>;

    /// Write guard for root node
    pub type RootWriteGuard<'a> = RefMut<'a, StructureNode>;

    /// Read access to the root node (shared borrow)
    pub fn root_read(root: &RootNode) -> RootReadGuard<'_> {
        root.borrow()
    }

    /// Write access to the root node (mutable borrow)
    pub fn root_write(root: &RootNode) -> RootWriteGuard<'_> {
        root.borrow_mut()
    }

    /// Execute a closure with read access to the root node
    /// Always succeeds in single-threaded mode
    pub fn root_read_with<F, R>(root: &RootNode, f: F) -> R
    where
        F: FnOnce(&StructureNode) -> R,
    {
        let guard = root_read(root);
        f(&guard)
    }
}

#[cfg(feature = "mutli-thread")]
mod impl_ {
    use super::StructureNode;
    use std::sync::{Arc, RwLock, RwLockReadGuard, RwLockWriteGuard};

    /// Multi-threaded root node type (thread-safe)
    pub type RootNode = Arc<RwLock<StructureNode>>;

    /// Create a new root node
    pub fn new_root_node(node: StructureNode) -> RootNode {
        Arc::new(RwLock::new(node))
    }

    /// Read guard for root node
    pub type RootReadGuard<'a> = RwLockReadGuard<'a, StructureNode>;

    /// Write guard for root node
    pub type RootWriteGuard<'a> = RwLockWriteGuard<'a, StructureNode>;

    /// Read access to the root node (shared lock)
    pub fn root_read(
        root: &RootNode,
    ) -> Result<RootReadGuard<'_>, std::sync::PoisonError<RwLockReadGuard<'_, StructureNode>>> {
        root.read()
    }

    /// Write access to the root node (exclusive lock)
    pub fn root_write(
        root: &RootNode,
    ) -> Result<RootWriteGuard<'_>, std::sync::PoisonError<RwLockWriteGuard<'_, StructureNode>>>
    {
        root.write()
    }

    /// Execute a closure with read access to the root node
    /// Returns default value if lock acquisition fails
    pub fn root_read_with<F, R>(root: &RootNode, f: F) -> R
    where
        F: FnOnce(&StructureNode) -> R,
        R: Default,
    {
        match root_read(root) {
            Ok(guard) => f(&guard),
            Err(_) => R::default(),
        }
    }
}

pub use impl_::{new_root_node, root_read, root_read_with, root_write, RootNode};