KFileDescriptor Class
Owning container for a file descriptor that automatically closes it on destruction. More...
| Header: | #include <KFileDescriptor> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS CoreAddons)target_link_libraries(mytarget PRIVATE KF6::CoreAddons) |
| Since: | 6.33 |
Public Functions
| KFileDescriptor() | |
| KFileDescriptor(int fd) | |
| KFileDescriptor(const KFileDescriptor &) | |
| KFileDescriptor(KFileDescriptor &&other) | |
| ~KFileDescriptor() | |
| KFileDescriptor | duplicate() const |
| int | get() const |
| bool | isValid() const |
| void | reset() |
| int | take() |
| operator bool() const | |
| KFileDescriptor & | operator=(KFileDescriptor &&other) |
| KFileDescriptor & | operator=(const KFileDescriptor &) |
Detailed Description
Warning: This class is not supported on Windows.
Member Function Documentation
[constexpr noexcept default] KFileDescriptor::KFileDescriptor()
Constructs an invalid KFileDescriptor
[explicit] KFileDescriptor::KFileDescriptor(int fd)
Constructs a KFileDescriptor that takes ownership of the given file descriptor
[delete] KFileDescriptor::KFileDescriptor(const KFileDescriptor &)
Copy-constructs an instance of KFileDescriptor. This function is deleted.
[noexcept] KFileDescriptor::KFileDescriptor(KFileDescriptor &&other)
Moves a KFileDescriptor
[noexcept] KFileDescriptor::~KFileDescriptor()
Destroys the KFileDescriptor and closes the file descriptor if it is valid
KFileDescriptor KFileDescriptor::duplicate() const
Duplicates the KFileDescriptor and its backing fd. The copy is always CLOEXEC.
int KFileDescriptor::get() const
Returns the file descriptor. The KFileDescriptor continues to have ownership!
bool KFileDescriptor::isValid() const
Returns true if the KFileDescriptor is valid (i.e. != -1)
void KFileDescriptor::reset()
Resets the KFileDescriptor to an invalid state, closing the file descriptor if it is valid.
int KFileDescriptor::take()
Releases ownership to the caller. The KFileDescriptor becomes invalid.
[explicit] KFileDescriptor::operator bool() const
Returns true if the KFileDescriptor is valid (i.e. != -1)
[noexcept] KFileDescriptor &KFileDescriptor::operator=(KFileDescriptor &&other)
Moves a KFileDescriptor
[delete] KFileDescriptor &KFileDescriptor::operator=(const KFileDescriptor &)
Copy-assigns other to this KFileDescriptor instance. This function is deleted.