Struct gio::Credentials

pub struct Credentials(_, _);

The 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::get_credentials.

Some operating systems supports securely sending and receiving credentials over a Unix Domain Socket, see UnixCredentialsMessage, UnixConnection::send_credentials and UnixConnection::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.

On FreeBSD, Debian GNU/kFreeBSD, and GNU/Hurd, the native credential type is a struct cmsgcred. This corresponds to CredentialsType::FreebsdCmsgcred.

On NetBSD, the native credential type is a struct unpcbid. This corresponds to CredentialsType::NetbsdUnpcbid.

On OpenBSD, the native credential type is a struct sockpeercred. This corresponds to CredentialsType::OpenbsdSockpeercred.

On Solaris (including OpenSolaris and its derivatives), the native credential type is a ucred_t. This corresponds to CredentialsType::SolarisUcred.

Implements

glib::object::ObjectExt

Methods

impl Credentials

pub fn new() -> Credentials

Creates a new Credentials object with credentials matching the the current process.

Returns

A Credentials. Free with gobject::ObjectExt::unref.

pub fn get_unix_pid(&self) -> Result<i32, Error>

Tries to get the UNIX process identifier from self. This method is only available on UNIX platforms.

This operation can fail if 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.

pub fn get_unix_user(&self) -> Result<(), Error>

Tries to get the UNIX user identifier from self. This method is only available on UNIX platforms.

This operation can fail if 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.

pub fn is_same_user(&self, other_credentials: &Credentials) -> Result<(), Error>

Checks if self and other_credentials is the same user.

This operation can fail if Credentials is not supported on the the OS.

other_credentials

A Credentials.

Returns

true if self and other_credentials has the same user, false otherwise or if error is set.

pub fn set_unix_user(&self, uid: u32) -> Result<(), Error>

Tries to set the UNIX user identifier on self. This method is only available on UNIX platforms.

This operation can fail if 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.

pub fn to_string(&self) -> GString

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.

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Credentials

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Credentials

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for Credentials

fn default() -> Self

Returns the "default value" for a type.

impl Display for Credentials

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Eq for Credentials

impl Hash for Credentials

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Credentials

fn cmp(&self, other: &Credentials) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for Credentials

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for Credentials

fn partial_cmp(&self, other: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Credentials

fn static_type() -> Type

Returns the type identifier of Self.