libproxy 0.1.1

Rust bindings for libproxy
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

use std::borrow::{Borrow, BorrowMut};
use std::ops::{Deref, DerefMut};
use std::ptr;
use std::slice;

use libc::{c_char, c_void, free};

use error::ProxyResolutionError;
use ffi::MallocCString;

/// A container type for holding the result of `px_proxy_factory_get_proxies`.
pub struct Proxies {
    data: *mut MallocCString,
    len: usize,
}

impl Proxies {
    pub(crate) fn new(data: *mut *mut c_char) -> Result<Proxies, ProxyResolutionError> {
        if data.is_null() {
            Err(ProxyResolutionError)
        } else {
            let mut len = 0;

            unsafe {
                let mut data_ptr = data;
                while !(*data_ptr).is_null() {
                    len += 1;
                    data_ptr = data_ptr.offset(1);
                }
            }

            Ok(Proxies {
                data: data as *mut MallocCString,
                len,
            })
        }
    }

    /// Extracts a slice containing the entire array.
    pub fn as_slice(&self) -> &[MallocCString] {
        unsafe { slice::from_raw_parts(self.data, self.len) }
    }

    /// Extracts a mutable slice of the entire array.
    pub fn as_mut_slice(&mut self) -> &mut [MallocCString] {
        unsafe { slice::from_raw_parts_mut(self.data, self.len) }
    }

    // TODO: impl Index(Mut) for Proxies
    // TODO: impl IntoIterator for Proxies
}

impl AsRef<[MallocCString]> for Proxies {
    fn as_ref(&self) -> &[MallocCString] {
        self.as_slice()
    }
}

impl AsMut<[MallocCString]> for Proxies {
    fn as_mut(&mut self) -> &mut [MallocCString] {
        self.as_mut_slice()
    }
}

impl Borrow<[MallocCString]> for Proxies {
    fn borrow(&self) -> &[MallocCString] {
        self.as_slice()
    }
}

impl BorrowMut<[MallocCString]> for Proxies {
    fn borrow_mut(&mut self) -> &mut [MallocCString] {
        self.as_mut_slice()
    }
}

impl Deref for Proxies {
    type Target = [MallocCString];

    fn deref(&self) -> &[MallocCString] {
        self.as_slice()
    }
}

impl DerefMut for Proxies {
    fn deref_mut(&mut self) -> &mut [MallocCString] {
        self.as_mut_slice()
    }
}

impl Drop for Proxies {
    fn drop(&mut self) {
        unsafe {
            // I don't fully understand it, but this (almost exactly) is what Vec does for dropping
            // its contained elements
            ptr::drop_in_place(self.as_mut_slice());

            free(self.data as *mut c_void)
        }
    }
}

impl<'a> IntoIterator for &'a Proxies {
    type Item = &'a MallocCString;
    type IntoIter = slice::Iter<'a, MallocCString>;

    #[allow(clippy::into_iter_on_ref)]
    fn into_iter(self) -> Self::IntoIter {
        self.as_slice().into_iter()
    }
}

impl<'a> IntoIterator for &'a mut Proxies {
    type Item = &'a mut MallocCString;
    type IntoIter = slice::IterMut<'a, MallocCString>;

    #[allow(clippy::into_iter_on_ref)]
    fn into_iter(self) -> Self::IntoIter {
        self.as_mut_slice().into_iter()
    }
}