Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext
direntry

Returns a mostly filled directory_entry for the file or directory referenced by this handle. Use metadata_flags::All if you want it as complete as your platform allows, even at the cost of severe performance loss.

Description

Related types: directory_entry, stat_t

Synopsis
virtual directory_entry handle::direntry(metadata_flags wanted = directory_entry::metadata_fastpath())
Parameters

Type

Concept

Name

Description

metadata_flags

wanted

The metadata wanted.

Returns

A directory entry for this handle.

Header

#include <boost/afio/v2/afio.hpp>

Race Guarantees

Operating system Race guarantees under a changing file system
FreeBSD Race free if handle open for directories and regular files only, else if handle closed or a symlink race free up to the containing directory. All metadata is fetched in a single shot.
Linux Race free if handle open, else if handle closed race free up to the containing directory. All metadata is fetched in a single shot.
OS X Race free if handle open for directories and regular files only. No guarantees if handle closed or a symlink.
Windows Handle must be open and is always race free. Metadata may be fetched in a single shot if at least two categories requested, or else the following categories apply: (i) ino (ii) type, atim, mtim, ctim, birthtim, sparse, compressed (iii) nlink, size, allocated, blocks.


PrevUpHomeNext