comparison libpam-sys/src/aliases.rs @ 174:9e4ce1631bd3

Dramatically expand documentation.
author Paul Fisher <paul@pfish.zone>
date Tue, 29 Jul 2025 18:58:27 -0400
parents 4b3a5095f68c
children
comparison
equal deleted inserted replaced
173:46e8ce5cd5d1 174:9e4ce1631bd3
8 /// The exact format of `messages` varies between Linux-PAM and other 8 /// The exact format of `messages` varies between Linux-PAM and other
9 /// implementations. See `libpam_sys_helpers::PtrPtrVec` for details 9 /// implementations. See `libpam_sys_helpers::PtrPtrVec` for details
10 /// (and a workaround). 10 /// (and a workaround).
11 /// 11 ///
12 /// ```no_run 12 /// ```no_run
13 /// use libpam_sys::aliases::ConversationCallback;
13 /// use libpam_sys::pam_conv; 14 /// use libpam_sys::pam_conv;
14 /// use libpam_sys::aliases::ConversationCallback;
15 /// fn convo() -> ConversationCallback { 15 /// fn convo() -> ConversationCallback {
16 /// // ... 16 /// // ...
17 /// # unimplemented!() 17 /// # unimplemented!()
18 /// } 18 /// }
19 /// let conv = pam_conv{conv: convo(), appdata_ptr: std::ptr::null_mut()}; 19 /// let conv = pam_conv {
20 /// conv: convo(),
21 /// appdata_ptr: std::ptr::null_mut(),
22 /// };
20 /// ``` 23 /// ```
21 pub type ConversationCallback = unsafe extern "C" fn( 24 pub type ConversationCallback = unsafe extern "C" fn(
22 num_msg: c_int, 25 num_msg: c_int,
23 msg: *const *const pam_message, 26 msg: *const *const pam_message,
24 resp: *mut *mut pam_response, 27 resp: *mut *mut pam_response,
27 30
28 /// Alias for the callback to [`pam_set_data`]. 31 /// Alias for the callback to [`pam_set_data`].
29 /// 32 ///
30 /// ```no_run 33 /// ```no_run
31 /// # use std::ffi::CString; 34 /// # use std::ffi::CString;
35 /// use libpam_sys::aliases::CleanupCallback;
32 /// use libpam_sys::pam_set_data; 36 /// use libpam_sys::pam_set_data;
33 /// use libpam_sys::aliases::CleanupCallback;
34 /// # use libpam_sys::pam_handle; 37 /// # use libpam_sys::pam_handle;
35 /// # let handle: *mut pam_handle = std::ptr::null_mut(); 38 /// # let handle: *mut pam_handle = std::ptr::null_mut();
36 /// # let mut my_data = 100; 39 /// # let mut my_data = 100;
37 /// # let data_ptr = &mut my_data as *mut i32; 40 /// # let data_ptr = &mut my_data as *mut i32;
38 /// fn cleanup() -> CleanupCallback { 41 /// fn cleanup() -> CleanupCallback {