surfing 0.1.1

A Rust library for parsing JSON objects from text streams
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

//! Marker module for JSON structure tracking.

use crate::constants::MARKERS;

/// Represents a JSON marker with its expected counterpart.
///
/// A marker is a character that indicates the beginning of a JSON structure
/// (such as '{' or '[') and has an expected closing counterpart ('}' or ']').
#[derive(Debug, Copy, Clone)]
pub struct Marker {
    /// The character that corresponds to the closing of this marker
    pub(crate) expected_counterpart: char,
}

impl Marker {
    /// Creates a new marker if the provided character is a valid opening marker.
    ///
    /// # Arguments
    ///
    /// * `marker` - A reference to the character to check.
    ///
    /// # Returns
    ///
    /// * `Some(Marker)` - If the character is a valid opening marker ('{' or '[').
    /// * `None` - If the character is not a valid opening marker.
    ///
    /// # Examples
    ///
    /// ```
    /// use surfing::parser::marker::Marker;
    ///
    /// let open_brace = Marker::new(&'{');
    /// assert!(open_brace.is_some());
    /// assert_eq!(open_brace.unwrap().is_counter_part(&'}'), true);
    ///
    /// let open_bracket = Marker::new(&'[');
    /// assert!(open_bracket.is_some());
    /// assert_eq!(open_bracket.unwrap().is_counter_part(&']'), true);
    ///
    /// let invalid = Marker::new(&'x');
    /// assert!(invalid.is_none());
    /// ```
    pub fn new(marker: &char) -> Option<Self> {
        for included_marker in MARKERS {
            if *marker == included_marker {
                if *marker == '{' {
                    return Some(Self {
                        expected_counterpart: '}',
                    });
                }
                
                if *marker == '[' {
                    return Some(Self {
                        expected_counterpart: ']',
                    });
                }
            }
        }
        
        None
    }
    
    /// Checks if the provided character is the corresponding counter part for this marker.
    ///
    /// # Arguments
    ///
    /// * `marker` - A reference to the character to check.
    ///
    /// # Returns
    ///
    /// * `true` - If the character is the expected counterpart for this marker.
    /// * `false` - If the character is not the expected counterpart.
    ///
    /// # Examples
    ///
    /// ```
    /// use surfing::parser::marker::Marker;
    ///
    /// let open_brace = Marker::new(&'{').unwrap();
    /// assert!(open_brace.is_counter_part(&'}'));
    /// assert!(!open_brace.is_counter_part(&']'));
    /// ```
    pub fn is_counter_part(&self, marker: &char) -> bool {
        self.expected_counterpart == *marker
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_marker_new() {
        let marker = Marker::new(&'{');
        assert!(marker.is_some());
        assert_eq!(marker.unwrap().expected_counterpart, '}');

        let marker = Marker::new(&'[');
        assert!(marker.is_some());
        assert_eq!(marker.unwrap().expected_counterpart, ']');

        let marker = Marker::new(&'x');
        assert!(marker.is_none());
    }

    #[test]
    fn test_marker_is_counter_part() {
        let marker = Marker::new(&'{').unwrap();
        assert!(marker.is_counter_part(&'}'));
        assert!(!marker.is_counter_part(&']'));

        let marker = Marker::new(&'[').unwrap();
        assert!(marker.is_counter_part(&']'));
        assert!(!marker.is_counter_part(&'}'));
    }
}