plist_plus 0.2.6

A library for reading and writing plists, compatible with libimobiledevice
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
117
118
119
120
121
122
123
124
125
126
127
128

// jkcoxson

use libc::c_void;
use log::trace;

use crate::{unsafe_bindings, Plist, PlistType};

pub struct PlistIterator {
    iter_pointer: *mut c_void,
    plist: Plist,
}

#[derive(Debug)]
pub struct PlistItem {
    pub plist: Plist,
    pub key: Option<String>,
}

impl IntoIterator for Plist {
    type Item = PlistItem;
    type IntoIter = PlistIterator;

    fn into_iter(self) -> Self::IntoIter {
        let mut pointer = unsafe { std::mem::zeroed() };
        match self.plist_type.clone() {
            PlistType::Array => unsafe {
                unsafe_bindings::plist_array_new_iter(self.plist_t, &mut pointer)
            },
            PlistType::Dictionary => unsafe {
                unsafe_bindings::plist_dict_new_iter(self.plist_t, &mut pointer)
            },
            _ => panic!("Cannot iterate over non-array or non-dictionary plist"),
        };

        PlistIterator {
            iter_pointer: pointer,
            plist: self,
        }
    }
}

impl Iterator for PlistIterator {
    type Item = PlistItem;

    fn next(&mut self) -> Option<Self::Item> {
        match self.plist.plist_type {
            PlistType::Array => {
                let to_fill = unsafe { std::mem::zeroed() };
                trace!("Getting next item in array");
                unsafe {
                    unsafe_bindings::plist_array_next_item(
                        self.plist.plist_t,
                        self.iter_pointer,
                        to_fill,
                    )
                };
                if to_fill.is_null() {
                    trace!("No more items in array");
                    None
                } else {
                    trace!("Getting type of next item in array");
                    Some(PlistItem {
                        plist: unsafe { *to_fill }.into(),
                        key: None,
                    })
                }
            }
            PlistType::Dictionary => {
                let mut key = unsafe { std::mem::zeroed() };
                let mut to_fill = unsafe { std::mem::zeroed() };
                trace!("Getting next item in dictionary");
                unsafe {
                    unsafe_bindings::plist_dict_next_item(
                        self.plist.plist_t,
                        self.iter_pointer,
                        &mut key,
                        &mut to_fill,
                    )
                };
                if to_fill.is_null() {
                    trace!("No more items in dictionary");
                    None
                } else {
                    let key_str = unsafe {
                        std::ffi::CString::from_raw(key)
                            .to_str()
                            .unwrap()
                            .to_string()
                    };
                    trace!("Getting type of next item in dictionary");
                    Some(PlistItem {
                        plist: to_fill.into(),
                        key: Some(key_str),
                    })
                }
            }
            _ => panic!("Cannot iterate over non-array or non-dictionary plist"),
        }
    }
}

impl Drop for PlistIterator {
    fn drop(&mut self) {
        // Free the pointer
        unsafe {
            libc::free(self.iter_pointer);
        }
    }
}

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

    #[test]
    fn iter_test() {
        let mut p = Plist::new_array();
        let _ = [0_u8; 4]
            .iter()
            .enumerate()
            .map(|(x, _)| p.array_append_item(x.into()).unwrap());
        let mut i = p.into_iter();
        let _ = [0_u8; 4]
            .iter()
            .enumerate()
            .map(|(x, _)| assert_eq!(x as u64, i.next().unwrap().plist.get_uint_val().unwrap()));
    }
}