Enum OpenFileKind 

pub enum OpenFileKind {
    File,
    Socket,
    Pipe,
    EventQueue,
    SharedMemory,
    Semaphore,
    Unknown,
}

What kind of object a file descriptor refers to.

The set is the intersection of what both platforms can name from a single read: macOS’ proc_fdtype values and the prefix of a /proc/<pid>/fd/<n> link target. It exists because §4’s “unavailable is never an empty string” needs an answer for a descriptor that has no path at all — a socket is not a nameless file, it is a socket, and the kind is what says so.

Variants

File

A file, directory, or device: something with a path in the filesystem.

Socket

A socket. Has no filesystem path unless it is a bound Unix socket, and neither platform reports that path through the descriptor table.

Pipe

A pipe or FIFO.

EventQueue

A kernel event queue: kqueue on macOS, epoll/eventfd/timerfd on Linux.

SharedMemory

POSIX shared memory.

Semaphore

A POSIX semaphore.

Unknown

The platform reported something we do not model.

Implementations

impl OpenFileKind

pub const fn label(self) -> &'static str

A lower-case label, in the same spirit as ProcessState::label.

Every label is strict 7-bit ASCII so it is legal in both glyph modes (§5.1).

pub const fn has_path(self) -> bool

Whether a descriptor of this kind can have a filesystem path at all.

The one thing that distinguishes “the OS refused the path” from “there is no path to refuse”: a collector that cannot resolve a Self::File’s path has hit a permission or read failure, while a Self::Socket’s path is MetricState::Unsupported on every platform and always will be.

Trait Implementations

impl Clone for OpenFileKind

fn clone(&self) -> OpenFileKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OpenFileKind

impl Debug for OpenFileKind

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

Formats the value using the given formatter.

impl Default for OpenFileKind

fn default() -> OpenFileKind

Returns the “default value” for a type.

impl Eq for OpenFileKind

impl Hash for OpenFileKind

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 for OpenFileKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for OpenFileKind