WPILibC++  2020.3.2-60-g3011ebe
wpi::sys::fs::basic_file_status Class Reference

Represents the result of a call to directory_iterator::status(). More...

#include <FileSystem.h>

Inheritance diagram for wpi::sys::fs::basic_file_status:
wpi::sys::fs::file_status

Public Member Functions

 basic_file_status (file_type Type)
 
 basic_file_status (file_type Type, perms Perms, time_t ATime, uint32_t ATimeNSec, time_t MTime, uint32_t MTimeNSec, uid_t UID, gid_t GID, off_t Size)
 
file_type type () const
 
perms permissions () const
 
TimePoint getLastAccessedTime () const
 The file access time as reported from the underlying file system. More...
 
TimePoint getLastModificationTime () const
 The file modification time as reported from the underlying file system. More...
 
uint32_t getUser () const
 
uint32_t getGroup () const
 
uint64_t getSize () const
 
void type (file_type v)
 
void permissions (perms p)
 

Protected Attributes

time_t fs_st_atime = 0
 
time_t fs_st_mtime = 0
 
uint32_t fs_st_atime_nsec = 0
 
uint32_t fs_st_mtime_nsec = 0
 
uid_t fs_st_uid = 0
 
gid_t fs_st_gid = 0
 
off_t fs_st_size = 0
 
file_type Type = file_type::status_error
 
perms Perms = perms_not_known
 

Detailed Description

Represents the result of a call to directory_iterator::status().

This is a subset of the information returned by a regular sys::fs::status() call, and represents the information provided by Windows FileFirstFile/FindNextFile.

Member Function Documentation

◆ getLastAccessedTime()

TimePoint wpi::sys::fs::basic_file_status::getLastAccessedTime ( ) const

The file access time as reported from the underlying file system.

Also see comments on getLastModificationTime() related to the precision of the returned value.

◆ getLastModificationTime()

TimePoint wpi::sys::fs::basic_file_status::getLastModificationTime ( ) const

The file modification time as reported from the underlying file system.

The returned value allows for nanosecond precision but the actual resolution is an implementation detail of the underlying file system. There is no guarantee for what kind of resolution you can expect, the resolution can differ across platforms and even across mountpoints on the same machine.


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