inspect-core 0.1.0

Core types and traits for the inspect-rs introspection system
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

//! Inspection limits and safety constraints.

/// Limits to prevent pathological inspection behavior.
///
/// These limits protect against accidentally traversing enormous data
/// structures, infinite loops, or excessive memory allocation during
/// introspection.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct InspectLimits {
    /// Maximum tree depth to traverse.
    pub max_depth: usize,

    /// Maximum number of items to inspect in a collection.
    pub max_items: usize,

    /// Maximum total number of nodes to visit.
    pub max_nodes: usize,

    /// Maximum length of a string to include.
    pub max_string_length: usize,

    /// Maximum number of bytes to include.
    pub max_bytes: usize,
}

impl InspectLimits {
    /// Create limits with all constraints set to maximum.
    pub const fn unlimited() -> Self {
        Self {
            max_depth: usize::MAX,
            max_items: usize::MAX,
            max_nodes: usize::MAX,
            max_string_length: usize::MAX,
            max_bytes: usize::MAX,
        }
    }

    /// Create limits suitable for interactive debugging.
    pub const fn debug() -> Self {
        Self {
            max_depth: 32,
            max_items: 100,
            max_nodes: 10_000,
            max_string_length: 1024,
            max_bytes: 4096,
        }
    }

    /// Create limits suitable for compact logging.
    pub const fn compact() -> Self {
        Self {
            max_depth: 8,
            max_items: 10,
            max_nodes: 1000,
            max_string_length: 128,
            max_bytes: 256,
        }
    }
}

impl Default for InspectLimits {
    fn default() -> Self {
        Self::debug()
    }
}