dendron 0.1.5

Generic tree data structure
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

//! Debug printing of a tree.

use core::fmt;

use crate::node::DebugPrintSubtreeDescendant;
use crate::tree::{Tree, TreeCore};

/// Tree printer for debugging.
///
/// This is provided mainly for debugging purpose. Node that the output format
/// is not guaranteed to be stable, and any format changes won't be considered
/// as breaking changes.
///
/// For usage and output examples, see
/// [`Node::debug_pretty_print`][`crate::Node::debug_pretty_print`] method.
#[derive(Clone, Copy)]
pub struct DebugPrettyPrint<'a, T> {
    /// Tree core.
    core: &'a TreeCore<T>,
}

impl<'a, T> DebugPrettyPrint<'a, T> {
    /// Creates a new `DebugPrint` object for the node.
    #[inline]
    pub(super) fn new(core: &'a TreeCore<T>) -> Self {
        Self { core }
    }
}

impl<'a, T: fmt::Display> fmt::Display for DebugPrettyPrint<'a, T> {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let root = self.core.root_link();
        crate::node::DebugPrettyPrint::new(&root).fmt(f)
    }
}

impl<'a, T: fmt::Debug> fmt::Debug for DebugPrettyPrint<'a, T> {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let root = self.core.root_link();
        crate::node::DebugPrettyPrint::new(&root).fmt(f)
    }
}

/// A wrapper to make a tree debug-printable without printing nodes.
#[derive(Clone, Copy)]
pub struct DebugPrintTreeLocal<'a, T> {
    /// Tree core.
    core: &'a TreeCore<T>,
}

impl<T> fmt::Debug for DebugPrintTreeLocal<'_, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("Tree")
            .field("lock_manager", &self.core.lock_manager)
            .finish()
    }
}

impl<'a, T> DebugPrintTreeLocal<'a, T> {
    /// Creates a new `DebugPrintTreeLocal`.
    #[inline]
    #[must_use]
    pub(super) fn new(core: &'a TreeCore<T>) -> Self {
        Self { core }
    }
}

/// A wrapper to make a node debug-printable with nodes.
#[derive(Clone, Copy)]
pub struct DebugPrintTree<'a, T> {
    /// Tree.
    tree: &'a Tree<T>,
}

impl<T: fmt::Debug> fmt::Debug for DebugPrintTree<'_, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let root_link = self.tree.core.root_link();
        f.debug_struct("Tree")
            .field("lock_manager", &self.tree.core.lock_manager)
            .field("nodes", &DebugPrintSubtreeDescendant::new_plain(&root_link))
            .finish()
    }
}

impl<'a, T: fmt::Debug> DebugPrintTree<'a, T> {
    /// Creates a new `DebugPrintTree`.
    #[inline]
    #[must_use]
    pub(super) fn new(tree: &'a Tree<T>) -> Self {
        Self { tree }
    }
}