contur::FileDescriptor Struct Reference

Descriptor handle returned by open(). More...

#include <file_descriptor.h>

Public Member Functions
constexpr bool	valid () const noexcept
	Returns true when descriptor is valid.

Public Attributes
std::int32_t	value = -1
	Underlying descriptor value.

Friends
constexpr bool	operator== (FileDescriptor lhs, FileDescriptor rhs) noexcept
	Equality comparison for descriptor values.

Detailed Description

Descriptor handle returned by open().

Definition at line 16 of file file_descriptor.h.

Member Function Documentation

valid()

bool contur::FileDescriptor::valid ( ) const

inlinenodiscardconstexprnoexcept

Returns true when descriptor is valid.

Returns

True if value >= 0.

Definition at line 23 of file file_descriptor.h.

Friends And Related Symbol Documentation

operator==

bool operator== ( FileDescriptor lhs, FileDescriptor rhs )

friend

Equality comparison for descriptor values.

Parameters

lhs	Left descriptor.
rhs	Right descriptor.

Returns

True when both descriptors hold the same value.

Definition at line 32 of file file_descriptor.h.

Member Data Documentation

value

std::int32_t contur::FileDescriptor::value = -1

Underlying descriptor value.

Definition at line 19 of file file_descriptor.h.

---

The documentation for this struct was generated from the following file:

• include/contur/fs/file_descriptor.h