libuv 2.13.1

A safe rust wrapper for libuv
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

use crate::{FromInner, HandleTrait, Inner, IntoInner};
use std::convert::TryFrom;
use uv::{uv_prepare_init, uv_prepare_start, uv_prepare_stop, uv_prepare_t};

callbacks! {
    pub PrepareCB(handle: PrepareHandle);
}

/// Additional data stored on the handle
#[derive(Default)]
pub(crate) struct PrepareDataFields<'a> {
    prepare_cb: PrepareCB<'a>,
}

/// Callback for uv_prepare_start
extern "C" fn uv_prepare_cb(handle: *mut uv_prepare_t) {
    let dataptr = crate::Handle::get_data(uv_handle!(handle));
    if !dataptr.is_null() {
        unsafe {
            if let super::PrepareData(d) = &mut (*dataptr).addl {
                d.prepare_cb.call(handle.into_inner());
            }
        }
    }
}

/// Prepare handles will run the given callback once per loop iteration, right before polling for
/// i/o.
#[derive(Clone, Copy)]
pub struct PrepareHandle {
    handle: *mut uv_prepare_t,
}

impl PrepareHandle {
    /// Create and initialize a new prepare handle
    pub fn new(r#loop: &crate::Loop) -> crate::Result<PrepareHandle> {
        let layout = std::alloc::Layout::new::<uv_prepare_t>();
        let handle = unsafe { std::alloc::alloc(layout) as *mut uv_prepare_t };
        if handle.is_null() {
            return Err(crate::Error::ENOMEM);
        }

        let ret = unsafe { uv_prepare_init(r#loop.into_inner(), handle) };
        if ret < 0 {
            unsafe { std::alloc::dealloc(handle as _, layout) };
            return Err(crate::Error::from_inner(ret as uv::uv_errno_t));
        }

        crate::Handle::initialize_data(uv_handle!(handle), super::PrepareData(Default::default()));

        Ok(PrepareHandle { handle })
    }

    /// Start the handle with the given callback. This function always succeeds, except when cb is
    /// ().
    pub fn start<CB: Into<PrepareCB<'static>>>(&mut self, cb: CB) -> crate::Result<()> {
        // uv_cb is either Some(uv_prepare_cb) or None
        let cb = cb.into();
        let uv_cb = use_c_callback!(uv_prepare_cb, cb);

        // cb is either Some(closure) or None - it is saved into data
        let dataptr = crate::Handle::get_data(uv_handle!(self.handle));
        if !dataptr.is_null() {
            if let super::PrepareData(d) = unsafe { &mut (*dataptr).addl } {
                d.prepare_cb = cb;
            }
        }

        crate::uvret(unsafe { uv_prepare_start(self.handle, uv_cb) })
    }

    /// Stop the handle, the callback will no longer be called. This function always succeeds.
    pub fn stop(&mut self) -> crate::Result<()> {
        crate::uvret(unsafe { uv_prepare_stop(self.handle) })
    }
}

impl FromInner<*mut uv_prepare_t> for PrepareHandle {
    fn from_inner(handle: *mut uv_prepare_t) -> PrepareHandle {
        PrepareHandle { handle }
    }
}

impl Inner<*mut uv::uv_handle_t> for PrepareHandle {
    fn inner(&self) -> *mut uv::uv_handle_t {
        uv_handle!(self.handle)
    }
}

impl From<PrepareHandle> for crate::Handle {
    fn from(prepare: PrepareHandle) -> crate::Handle {
        crate::Handle::from_inner(Inner::<*mut uv::uv_handle_t>::inner(&prepare))
    }
}

impl crate::ToHandle for PrepareHandle {
    fn to_handle(&self) -> crate::Handle {
        crate::Handle::from_inner(Inner::<*mut uv::uv_handle_t>::inner(self))
    }
}

impl TryFrom<crate::Handle> for PrepareHandle {
    type Error = crate::ConversionError;

    fn try_from(handle: crate::Handle) -> Result<Self, Self::Error> {
        let t = handle.get_type();
        if t != crate::HandleType::PREPARE {
            Err(crate::ConversionError::new(t, crate::HandleType::PREPARE))
        } else {
            Ok((handle.inner() as *mut uv_prepare_t).into_inner())
        }
    }
}

impl HandleTrait for PrepareHandle {}

impl crate::Loop {
    /// Create and initialize a new prepare handle
    pub fn prepare(&self) -> crate::Result<PrepareHandle> {
        PrepareHandle::new(self)
    }
}