Struct gio::UnixCredentialsMessage

pub struct UnixCredentialsMessage { /* private fields */ }

Available on Unix only.

This SocketControlMessage contains a Credentials instance. It may be sent using SocketExtManual::send_message() and received using SocketExtManual::receive_message() over UNIX sockets (ie: sockets in the SocketFamily::Unix family).

For an easier way to send and receive credentials over stream-oriented UNIX sockets, see g_unix_connection_send_credentials() and g_unix_connection_receive_credentials(). To receive credentials of a foreign process connected to a socket, use SocketExt::credentials().

Since GLib 2.72, GUnixCredentialMessage is available on all platforms. It requires underlying system support (such as Windows 10 with AF_UNIX) at run time.

Before GLib 2.72, <gio/gunixcredentialsmessage.h> belonged to the UNIX-specific GIO interfaces, thus you had to use the gio-unix-2.0.pc pkg-config file when using it. This is no longer necessary since GLib 2.72.

Properties

credentials

The credentials stored in the message.

Readable | Writeable | Construct Only

Implements

UnixCredentialsMessageExt, SocketControlMessageExt, glib::ObjectExt, SocketControlMessageExtManual

Implementations

impl UnixCredentialsMessage

pub const NONE: Option<&'static UnixCredentialsMessage> = None

pub fn new() -> UnixCredentialsMessage

Creates a new UnixCredentialsMessage with credentials matching the current processes.

Returns

a new UnixCredentialsMessage

pub fn with_credentials(credentials: &Credentials) -> UnixCredentialsMessage

Creates a new UnixCredentialsMessage holding credentials.

credentials

A Credentials object.

Returns

a new UnixCredentialsMessage

pub fn is_supported() -> bool

Checks if passing Credentials on a Socket is supported on this platform.

Returns

true if supported, false otherwise

Trait Implementations

impl Clone for UnixCredentialsMessage

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnixCredentialsMessage

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

Formats the value using the given formatter.

impl Default for UnixCredentialsMessage

fn default() -> Self

Returns the “default value” for a type.

impl Display for UnixCredentialsMessage

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

Formats the value using the given formatter.

impl HasParamSpec for UnixCredentialsMessage

type ParamSpec = ParamSpecObject

type SetValue = UnixCredentialsMessage

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, UnixCredentialsMessage>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for UnixCredentialsMessage

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

where H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for UnixCredentialsMessage

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for UnixCredentialsMessage

type Parent = SocketControlMessage

impl<OT: ObjectType> PartialEq<OT> for UnixCredentialsMessage

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for UnixCredentialsMessage

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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 UnixCredentialsMessage

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for UnixCredentialsMessage

impl IsA<SocketControlMessage> for UnixCredentialsMessage