Get file status.
More...
#include <util.h>
|
enum | error_code { FILE,
FD
} |
| Error codes. More...
|
|
enum | mode_bits {
FILE_TYPE_MASK = S_IFMT,
FILE_TYPE_SOCKET = S_IFSOCK,
FILE_TYPE_LINK = S_IFLNK,
FILE_TYPE_REGULAR = S_IFREG,
FILE_TYPE_BLOCK = S_IFBLK,
FILE_TYPE_DIRECTORY = S_IFDIR,
FILE_TYPE_CHARACTER = S_IFCHR,
FILE_TYPE_FIFO = S_IFIFO,
PERM_SETUID = S_ISUID,
PERM_SETGIT = S_ISGID,
PERM_STICKY = S_ISVTX,
PERM_USER_MASK = S_IRWXU,
PERM_USER_READ = S_IRUSR,
PERM_USER_WRITE = S_IWUSR,
PERM_USER_EXECUTE = S_IXUSR,
PERM_GROUP_MASK = S_IRWXG,
PERM_GROUP_READ = S_IRGRP,
PERM_GROUP_WRITE = S_IWGRP,
PERM_GROUP_EXECUTE = S_IXGRP,
PERM_OTHER_MASK = S_IRWXO,
PERM_OTHER_READ = S_IROTH,
PERM_OTHER_WRITE = S_IWOTH,
PERM_OTHER_EXECUTE = S_IXOTH
} |
| Mode bits. More...
|
|
typedef custom_error< error_code > | error |
| Exception type.
|
|
|
std::string | file |
| The filename being checked (if specified).
|
|
int | fd |
| The file descriptor being checked (if specified).
|
|
int | errorno |
| The error number set after stat(2) error.
|
|
struct::stat | status |
| The stat(2) results.
|
|
Get file status.
stat(2) wrapper.
Error codes.
Enumerator |
---|
FILE |
Failed to stat file.
|
FD |
Failed to stat file descriptor.
|
Mode bits.
Enumerator |
---|
FILE_TYPE_MASK |
Mask for file type bit fields.
|
FILE_TYPE_SOCKET |
Socket file type.
|
FILE_TYPE_LINK |
Symbolic link file type.
|
FILE_TYPE_REGULAR |
Regular file type.
|
FILE_TYPE_BLOCK |
Block device file type.
|
FILE_TYPE_DIRECTORY |
Directory file type.
|
FILE_TYPE_CHARACTER |
Character device file type.
|
FILE_TYPE_FIFO |
Named pipe (FIFO) file type.
|
PERM_SETUID |
Set user ID permission.
|
PERM_SETGIT |
Set group ID permission.
|
PERM_STICKY |
Sticky permission.
|
PERM_USER_MASK |
Mask for user permissions.
|
PERM_USER_READ |
User read permission.
|
PERM_USER_WRITE |
User write permission.
|
PERM_USER_EXECUTE |
User execute permission.
|
PERM_GROUP_MASK |
Mask for group permissions.
|
PERM_GROUP_READ |
Group read permission.
|
PERM_GROUP_WRITE |
Group write permission.
|
PERM_GROUP_EXECUTE |
Group execute permission.
|
PERM_OTHER_MASK |
Mask for other permissions.
|
PERM_OTHER_READ |
Other read permission.
|
PERM_OTHER_WRITE |
Other write permission.
|
PERM_OTHER_EXECUTE |
Other execute permission.
|
sbuild::stat::stat |
( |
const char * |
file, |
|
|
bool |
link = false |
|
) |
| |
The constructor.
- Parameters
-
file | the filename to use. |
link | use lstat rather than stat (i.e. don't follow symlinks). |
References errorno, and status.
Referenced by stat().
sbuild::stat::stat |
( |
const std::string & |
file, |
|
|
bool |
link = false |
|
) |
| |
The constructor.
- Parameters
-
file | the filename to use. |
link | use lstat rather than stat (i.e. don't follow symlinks). |
References errorno, stat(), and status.
sbuild::stat::stat |
( |
const std::string & |
file, |
|
|
int |
fd |
|
) |
| |
The constructor.
- Parameters
-
file | the filename to use (only used for error reporting). |
fd | the file descriptor to use. |
References errorno, and status.
sbuild::stat::stat |
( |
int |
fd) | |
|
The constructor.
- Parameters
-
fd | the file descriptor to use. |
References errorno, and status.
time_t sbuild::stat::atime |
( |
) | |
const |
|
inline |
Get the file access time.
- Returns
- the access time.
References check(), and status.
blkcnt_t sbuild::stat::blocks |
( |
) | |
const |
|
inline |
Get the file block count.
- Returns
- the block count.
References check(), and status.
blksize_t sbuild::stat::blocksize |
( |
) | |
const |
|
inline |
Get the file block size.
- Returns
- the block size.
References check(), and status.
void sbuild::stat::check |
( |
) | |
const |
|
inline |
Check if the file status was obtained.
An error will be thrown if stat(2) failed to get the file status.
References errorno, FD, fd, FILE, and file.
Referenced by atime(), blocks(), blocksize(), check_mode(), ctime(), device(), sbuild::session::get_shell(), gid(), inode(), links(), mode(), mtime(), size(), and uid().
bool sbuild::stat::check_mode |
( |
mode_bits |
mask) | |
const |
|
inline |
time_t sbuild::stat::ctime |
( |
) | |
const |
|
inline |
Get the file creation time.
- Returns
- the creation time.
References check(), and status.
dev_t sbuild::stat::device |
( |
) | |
const |
|
inline |
Get the device the file resides on.
- Returns
- the device.
References check(), and status.
struct ::stat& sbuild::stat::get_detail |
( |
) | |
|
|
inline |
Get the struct stat used internally.
This is returned by stat(2).
- Returns
- the stat struct.
References status.
gid_t sbuild::stat::gid |
( |
) | |
const |
|
inline |
Get the group id owning the file.
- Returns
- the uid.
References check(), and status.
ino_t sbuild::stat::inode |
( |
) | |
const |
|
inline |
Get the inode of the file.
- Returns
- the inode.
References check(), and status.
bool sbuild::stat::is_block |
( |
) | |
const |
|
inline |
bool sbuild::stat::is_character |
( |
) | |
const |
|
inline |
bool sbuild::stat::is_directory |
( |
) | |
const |
|
inline |
bool sbuild::stat::is_fifo |
( |
) | |
const |
|
inline |
bool sbuild::stat::is_link |
( |
) | |
const |
|
inline |
bool sbuild::stat::is_regular |
( |
) | |
const |
|
inline |
bool sbuild::stat::is_socket |
( |
) | |
const |
|
inline |
nlink_t sbuild::stat::links |
( |
) | |
const |
|
inline |
Get the number of hard links to the file.
- Returns
- the hard link count.
References check(), and status.
mode_t sbuild::stat::mode |
( |
) | |
const |
|
inline |
Get the mode of the file.
- Returns
- the mode.
References check(), and status.
time_t sbuild::stat::mtime |
( |
) | |
const |
|
inline |
Get the file modification time.
- Returns
- the modification time.
References check(), and status.
off_t sbuild::stat::size |
( |
) | |
const |
|
inline |
Get the file size.
- Returns
- the file size.
References check(), and status.
uid_t sbuild::stat::uid |
( |
) | |
const |
|
inline |
The documentation for this class was generated from the following files:
- lib/sbuild/util.h
- lib/sbuild/util.cc