Enum interprocess_docfix::local_socket::NameTypeSupport

pub enum NameTypeSupport {
    OnlyPaths,
    OnlyNamespaced,
    Both,
}

Represents which kinds of identifiers can be used for a local socket’s name on the current platform.

Variants

OnlyPaths

Only filesystem paths can be used.

This is true for all Unix/POSIX and Unix-like systems other than Linux.

OnlyNamespaced

Only names in an dedicated namespace can be used.

This is true only for Windows.

Both

Both of the above options are available.

This is true only for Linux.

Implementations

impl NameTypeSupport

pub const ALWAYS_AVAILABLE: Self = NAME_TYPE_ALWAYS_SUPPORTED_REAL

The types of local socket names supported on the current platform regardless of the environment and OS version.

On most platforms, the value is known at compile time, i.e. the support for paths wasn’t introduced in a specific version of the OS or isn’t known to be supported at all. Currently, this includes all supported OSes. If support is added for an OS which added this functionality in a specific version, this constant will be the most restrictive value for that platform, with query possibly returning the actual value according to the current version of the OS.

Simply put, you should probably just use this value for consistency across platforms, unless you really need a specific name type to be supported.

pub fn query() -> Self

Returns the types of local socket names supported on the current platform with the current environment.

On most platforms, the value is known at compile time, i.e. the support for one of the types wasn’t introduced in an update to the OS or isn’t known to be supported at all. Currently, this includes all supported OSes. For compatibility with OSes which might add the functionality in the future starting with a specific version, this function isn’t a const fn – see ALWAYS_AVAILABLE if you need a constant expression.

pub const fn paths_supported(self) -> bool

Returns true if, according to self, filesystem-based local sockets are supported; false otherwise.

pub const fn namespace_supported(self) -> bool

Returns true if, according to self, namespaced local socket names are supported; false otherwise.

Trait Implementations

impl Clone for NameTypeSupport

fn clone(&self) -> NameTypeSupport

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NameTypeSupport

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

Formats the value using the given formatter.

impl Hash for NameTypeSupport

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<NameTypeSupport> for NameTypeSupport

fn eq(&self, other: &NameTypeSupport) -> 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 Copy for NameTypeSupport

impl Eq for NameTypeSupport

impl StructuralEq for NameTypeSupport

impl StructuralPartialEq for NameTypeSupport