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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use glib::translate::*;
use std::{fmt, ptr};
glib::wrapper! {
/// The [`Credentials`][crate::Credentials] type is a reference-counted wrapper for native
/// credentials. This information is typically used for identifying,
/// authenticating and authorizing other processes.
///
/// Some operating systems supports looking up the credentials of the
/// remote peer of a communication endpoint - see e.g.
/// [`SocketExt::credentials()`][crate::prelude::SocketExt::credentials()].
///
/// Some operating systems supports securely sending and receiving
/// credentials over a Unix Domain Socket, see
/// [`UnixCredentialsMessage`][crate::UnixCredentialsMessage], `g_unix_connection_send_credentials()` and
/// `g_unix_connection_receive_credentials()` for details.
///
/// On Linux, the native credential type is a `struct ucred` - see the
/// unix(7) man page for details. This corresponds to
/// [`CredentialsType::LinuxUcred`][crate::CredentialsType::LinuxUcred].
///
/// On Apple operating systems (including iOS, tvOS, and macOS),
/// the native credential type is a `struct xucred`.
/// This corresponds to [`CredentialsType::AppleXucred`][crate::CredentialsType::AppleXucred].
///
/// On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native
/// credential type is a `struct cmsgcred`. This corresponds
/// to [`CredentialsType::FreebsdCmsgcred`][crate::CredentialsType::FreebsdCmsgcred].
///
/// On NetBSD, the native credential type is a `struct unpcbid`.
/// This corresponds to [`CredentialsType::NetbsdUnpcbid`][crate::CredentialsType::NetbsdUnpcbid].
///
/// On OpenBSD, the native credential type is a `struct sockpeercred`.
/// This corresponds to [`CredentialsType::OpenbsdSockpeercred`][crate::CredentialsType::OpenbsdSockpeercred].
///
/// On Solaris (including OpenSolaris and its derivatives), the native
/// credential type is a `ucred_t`. This corresponds to
/// [`CredentialsType::SolarisUcred`][crate::CredentialsType::SolarisUcred].
///
/// Since GLib 2.72, on Windows, the native credentials may contain the PID of a
/// process. This corresponds to [`CredentialsType::Win32Pid`][crate::CredentialsType::Win32Pid].
///
/// # Implements
///
/// [`trait@glib::ObjectExt`]
#[doc(alias = "GCredentials")]
pub struct Credentials(Object<ffi::GCredentials, ffi::GCredentialsClass>);
match fn {
type_ => || ffi::g_credentials_get_type(),
}
}
impl Credentials {
/// Creates a new [`Credentials`][crate::Credentials] object with credentials matching the
/// the current process.
///
/// # Returns
///
/// A [`Credentials`][crate::Credentials]. Free with `g_object_unref()`.
#[doc(alias = "g_credentials_new")]
pub fn new() -> Credentials {
unsafe { from_glib_full(ffi::g_credentials_new()) }
}
//#[doc(alias = "g_credentials_get_native")]
//#[doc(alias = "get_native")]
//pub fn native(&self, native_type: CredentialsType) -> /*Unimplemented*/Option<Basic: Pointer> {
// unsafe { TODO: call ffi:g_credentials_get_native() }
//}
/// Tries to get the UNIX process identifier from `self`. This
/// method is only available on UNIX platforms.
///
/// This operation can fail if [`Credentials`][crate::Credentials] is not supported on the
/// OS or if the native credentials type does not contain information
/// about the UNIX process ID.
///
/// # Returns
///
/// The UNIX process ID, or `-1` if `error` is set.
#[cfg(unix)]
#[cfg_attr(docsrs, doc(cfg(unix)))]
#[doc(alias = "g_credentials_get_unix_pid")]
#[doc(alias = "get_unix_pid")]
pub fn unix_pid(&self) -> Result<i32, glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::g_credentials_get_unix_pid(self.to_glib_none().0, &mut error);
if error.is_null() {
Ok(ret)
} else {
Err(from_glib_full(error))
}
}
}
/// Tries to get the UNIX user identifier from `self`. This
/// method is only available on UNIX platforms.
///
/// This operation can fail if [`Credentials`][crate::Credentials] is not supported on the
/// OS or if the native credentials type does not contain information
/// about the UNIX user.
///
/// # Returns
///
/// The UNIX user identifier or `-1` if `error` is set.
#[cfg(unix)]
#[cfg_attr(docsrs, doc(cfg(unix)))]
#[doc(alias = "g_credentials_get_unix_user")]
#[doc(alias = "get_unix_user")]
pub fn unix_user(&self) -> Result<u32, glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::g_credentials_get_unix_user(self.to_glib_none().0, &mut error);
if error.is_null() {
Ok(ret)
} else {
Err(from_glib_full(error))
}
}
}
/// Checks if `self` and `other_credentials` is the same user.
///
/// This operation can fail if [`Credentials`][crate::Credentials] is not supported on the
/// the OS.
/// ## `other_credentials`
/// A [`Credentials`][crate::Credentials].
///
/// # Returns
///
/// [`true`] if `self` and `other_credentials` has the same
/// user, [`false`] otherwise or if `error` is set.
#[doc(alias = "g_credentials_is_same_user")]
pub fn is_same_user(&self, other_credentials: &Credentials) -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok = ffi::g_credentials_is_same_user(
self.to_glib_none().0,
other_credentials.to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
//#[doc(alias = "g_credentials_set_native")]
//pub fn set_native(&self, native_type: CredentialsType, native: /*Unimplemented*/Basic: Pointer) {
// unsafe { TODO: call ffi:g_credentials_set_native() }
//}
/// Tries to set the UNIX user identifier on `self`. This method
/// is only available on UNIX platforms.
///
/// This operation can fail if [`Credentials`][crate::Credentials] is not supported on the
/// OS or if the native credentials type does not contain information
/// about the UNIX user. It can also fail if the OS does not allow the
/// use of "spoofed" credentials.
/// ## `uid`
/// The UNIX user identifier to set.
///
/// # Returns
///
/// [`true`] if `uid` was set, [`false`] if error is set.
#[cfg(unix)]
#[cfg_attr(docsrs, doc(cfg(unix)))]
#[doc(alias = "g_credentials_set_unix_user")]
pub fn set_unix_user(&self, uid: u32) -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok = ffi::g_credentials_set_unix_user(self.to_glib_none().0, uid, &mut error);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a human-readable textual representation of `self`
/// that can be used in logging and debug messages. The format of the
/// returned string may change in future GLib release.
///
/// # Returns
///
/// A string that should be freed with `g_free()`.
#[doc(alias = "g_credentials_to_string")]
#[doc(alias = "to_string")]
pub fn to_str(&self) -> glib::GString {
unsafe { from_glib_full(ffi::g_credentials_to_string(self.to_glib_none().0)) }
}
}
impl Default for Credentials {
fn default() -> Self {
Self::new()
}
}
impl fmt::Display for Credentials {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str(&self.to_str())
}
}