Struct gio::UnixSocketAddress

#[repr(transparent)]
pub struct UnixSocketAddress { /* private fields */ }

Available on Unix only.

Support for UNIX-domain (also known as local) sockets.

UNIX domain sockets are generally visible in the filesystem. However, some systems support abstract socket names which are not visible in the filesystem and not affected by the filesystem permissions, visibility, etc. Currently this is only supported under Linux. If you attempt to use abstract sockets on other systems, function calls may return IOErrorEnum::NotSupported errors. You can use abstract_names_supported() to see if abstract names are supported.

Since GLib 2.72, UnixSocketAddress 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/gunixsocketaddress.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.

Implements

UnixSocketAddressExt, SocketAddressExt, glib::ObjectExt, SocketConnectableExt, UnixSocketAddressExtManual

Implementations

impl UnixSocketAddress

pub fn new(path: &Path) -> UnixSocketAddress

Creates a new UnixSocketAddress for path.

To create abstract socket addresses, on systems that support that, use g_unix_socket_address_new_abstract().

path

the socket path

Returns

a new UnixSocketAddress

pub fn with_type(address_type: UnixSocketAddressPath<'_>) -> Self

Creates a new UnixSocketAddress of type type_ with name path.

If type_ is UnixSocketAddressType::Path, this is equivalent to calling new().

If type_ is UnixSocketAddressType::Anonymous, path and path_len will be ignored.

If path_type is UnixSocketAddressType::Abstract, then path_len bytes of path will be copied to the socket’s path, and only those bytes will be considered part of the name. (If path_len is -1, then path is assumed to be NUL-terminated.) For example, if path was “test”, then calling SocketAddressExt::native_size() on the returned socket would return 7 (2 bytes of overhead, 1 byte for the abstract-socket indicator byte, and 4 bytes for the name “test”).

If path_type is UnixSocketAddressType::AbstractPadded, then path_len bytes of path will be copied to the socket’s path, the rest of the path will be padded with 0 bytes, and the entire zero-padded buffer will be considered the name. (As above, if path_len is -1, then path is assumed to be NUL-terminated.) In this case, SocketAddressExt::native_size() will always return the full size of a struct sockaddr_un, although UnixSocketAddressExt::path_len() will still return just the length of path.

UnixSocketAddressType::Abstract is preferred over UnixSocketAddressType::AbstractPadded for new programs. Of course, when connecting to a server created by another process, you must use the appropriate type corresponding to how that process created its listening socket.

path

the name

type_

a UnixSocketAddressType

Returns

a new UnixSocketAddress

impl UnixSocketAddress

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

pub fn abstract_names_supported() -> bool

Checks if abstract UNIX domain socket names are supported.

Returns

true if supported, false otherwise

Trait Implementations

impl Clone for UnixSocketAddress

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 UnixSocketAddress

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

Formats the value using the given formatter.

impl Display for UnixSocketAddress

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

Formats the value using the given formatter.

impl Hash for UnixSocketAddress

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 UnixSocketAddress

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for UnixSocketAddress

type Parent = SocketAddress

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

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 UnixSocketAddress

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 UnixSocketAddress

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for UnixSocketAddress

impl IsA<SocketAddress> for UnixSocketAddress

impl IsA<SocketConnectable> for UnixSocketAddress

impl Send for UnixSocketAddress

impl Sync for UnixSocketAddress