ql_file.dox.h
namespace Qore {
struct StatInfo {
date atime;
int blksize;
int blocks;
date ctime;
int dev;
int gid;
int inode;
int mode;
date mtime;
int nlink;
string perm;
int rdev;
int size;
string type;
int uid;
};
}
namespace Qore {
struct FilesystemInfo {
int bavail;
int bfree;
int blocks;
int bsize;
int favail;
int ffree;
int files;
int frsize;
int fsid;
int namemax;
};
}
namespace Qore {
bool absolute_path(string path);
bool absolute_path_unix(string path);
bool absolute_path_windows(string path);
int chdir(string path);
int chmod(string path, softint mode);
int chown(string path, softint owner = -1, softint group = -1);
*string getcwd();
string getcwd2();
*list<string> glob(string glob_str);
nothing glob();
*hash<StatInfo> hlstat(string path);
nothing hlstat();
*hash<StatInfo> hstat(string path);
nothing hstat();
bool is_bdev(string path);
bool is_cdev(string path);
bool is_dev(string path);
bool is_dir(string path);
bool is_executable(string path);
bool is_file(string path);
bool is_link(string path);
bool is_pipe(string path);
bool is_readable(string path);
bool is_socket(string path);
bool is_writable(string path);
bool is_writeable(string path);
int lchown(string path, softint uid = -1, softint gid = -1);
*list<auto> lstat(string path);
nothing lstat();
int mkdir(string path, softint mode = 0777, bool parents = False);
nothing mkdir_ex(string path, softint mode = 0777, bool parents = False);
int mkfifo(string path, softint mode = 0600);
string readlink(string path);
string realpath(string path);
nothing rename(string old_path, string new_path);
int rmdir(string path);
*list<auto> stat(string path);
nothing stat();
*hash<FilesystemInfo> statvfs(string path);
nothing symlink(string old_path, string new_path);
int umask(softint mask);
nothing umask();
int unlink(string path);
nothing unlink();
}
Qore::False
const False
logical False
Definition: qc_qore.dox.h:96
Qore::date
date date(date dt)
Returns the date passed.
Qore
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
Qore::is_executable
bool is_executable(string path)
Returns True if the string passed identifies an executable on the filesystem, False if not.
Qore::is_bdev
bool is_bdev(string path)
Returns True if the string passed identifies a block device on the filesystem, False if not.
Qore::chmod
int chmod(string path, softint mode)
Changes the mode of a file or directory.
Qore::is_writable
bool is_writable(string path)
Returns True if the string passed identifies a file or a directory writable by the current user,...
Qore::glob
*list< string > glob(string glob_str)
Returns a list of files matching the string argument or NOTHING if the call to glob() fails.
Qore::getcwd2
string getcwd2()
Returns a string giving the current working directory; throws an exception if the current directory c...
Qore::is_dir
bool is_dir(string path)
Returns True if the string passed identifies a directory on the filesystem, False if not.
Qore::chown
int chown(string path, softint owner=-1, softint group=-1)
Changes the user and group owners of a file, if the current user has permission to do so (normally on...
Qore::lstat
*list< auto > lstat(string path)
Returns a list of file status values for the path argument and does not follow symbolic links; if any...
Qore::rename
nothing rename(string old_path, string new_path)
Renames (or moves) files or directories. Note that for this call to function properly,...
Qore::is_link
bool is_link(string path)
Returns True if the string passed identifies a symbolic link on the filesystem, False if not.
Qore::is_socket
bool is_socket(string path)
Returns True if the string passed identifies a socket on the filesystem, False if not.
Qore::is_cdev
bool is_cdev(string path)
Returns True if the string passed identifies a character device on the filesystem,...
Qore::rmdir
int rmdir(string path)
Removes a directory.
Qore::is_dev
bool is_dev(string path)
Returns True if the string passed identifies a device (either block or character) on the filesystem,...
Qore::absolute_path
bool absolute_path(string path)
returns True if the argument is an absolute path on the current platform, False if not
Qore::realpath
string realpath(string path)
Returns the canonicalized absolute pathname from the given path.
Qore::readlink
string readlink(string path)
Returns the target of a symbolic link; throws an exception if an error occurs (ex: file does not exis...
Qore::is_file
bool is_file(string path)
Returns True if the string passed identifies a regular file on the filesystem, False if not.
Qore::mkfifo
int mkfifo(string path, softint mode=0600)
Creates a named pipe file with an optional file mode.
Qore::is_pipe
bool is_pipe(string path)
Returns True if the string passed identifies a pipe (FIFO) on the filesystem, False if not.
Qore::absolute_path_windows
bool absolute_path_windows(string path)
returns True if the argument is a Windows absolute path, False if not
Qore::hlstat
*hash< StatInfo > hlstat(string path)
Returns a StatInfo hash for the path argument and does not follow symbolic links; if any errors occur...
Qore::mkdir
int mkdir(string path, softint mode=0777, bool parents=False)
Creates a directory, optionally specifying the mode.
Qore::getcwd
*string getcwd()
Returns a string giving the current working directory or NOTHING if the current working directory cou...
Qore::mkdir_ex
nothing mkdir_ex(string path, softint mode=0777, bool parents=False)
Creates a directory, optionally specifying the mode; throws an exception on error.
Qore::lchown
int lchown(string path, softint uid=-1, softint gid=-1)
Changes the user and group owners of a file, if the current user has permission to do so (normally on...
Qore::is_writeable
bool is_writeable(string path)
Returns True if the string passed identifies a file or a directory writable by the current user (back...
Qore::unlink
int unlink(string path)
Deletes a file and returns 0 for success, -1 for error (in which case errno() can be used to get the ...
Qore::hstat
*hash< StatInfo > hstat(string path)
Returns a StatInfo hash for the path argument, following any symbolic links; if any errors occur,...
Qore::stat
*list< auto > stat(string path)
Returns a list of file status values for the path argument, following any symbolic links; if any erro...
Qore::absolute_path_unix
bool absolute_path_unix(string path)
returns True if the argument is a UNIX absolute path, False if not
Qore::umask
int umask(softint mask)
Sets the file creation mode mask for the process and returns the previous value of the file creation ...
Qore::chdir
int chdir(string path)
Changes the current working directory for the current process.
Qore::statvfs
*hash< FilesystemInfo > statvfs(string path)
Returns a hash of filesystem status values for the file or directory path passed.
Qore::symlink
nothing symlink(string old_path, string new_path)
Creates a symbolic link to a directory path. Note that for this call to function properly,...
Qore::is_readable
bool is_readable(string path)
Returns True if the string passed identifies a file or a directory readable by the current user,...
Qore::FilesystemInfo
Filesystem info hash as returned by statvfs, Dir::statvfs, and ReadOnlyFile::statvfs()".
Definition: ql_file.dox.h:46
Qore::FilesystemInfo::ffree
int ffree
The total number of free inodes available to privileged users.
Definition: ql_file.dox.h:58
Qore::FilesystemInfo::files
int files
The total number of inodes on the filesystem.
Definition: ql_file.dox.h:60
Qore::FilesystemInfo::fsid
int fsid
The filesystem ID; may not be set or meaningful on all filesystems/systems: see system documentation ...
Definition: ql_file.dox.h:64
Qore::FilesystemInfo::bsize
int bsize
The filesystem's block size.
Definition: ql_file.dox.h:54
Qore::FilesystemInfo::blocks
int blocks
The total number of blocks on the filesystem (capacity in bytes = bsize * blocks)
Definition: ql_file.dox.h:52
Qore::FilesystemInfo::namemax
int namemax
The maximum length in bytes of file names on the filesystem.
Definition: ql_file.dox.h:66
Qore::FilesystemInfo::favail
int favail
The number of free inodes available to unprivileged users.
Definition: ql_file.dox.h:56
Qore::FilesystemInfo::bavail
int bavail
The number of free blocks available to unprivileged users (bytes = bsize * bavail)
Definition: ql_file.dox.h:48
Qore::FilesystemInfo::bfree
int bfree
The total number of free indes available to privileged users (bytes = bsize * bfree)
Definition: ql_file.dox.h:50
Qore::FilesystemInfo::frsize
int frsize
The size in bytes of the minimum allocation unit on the filesystem.
Definition: ql_file.dox.h:62
Qore::StatInfo
file status information hash as returned from hstat(), hlstat(), Dir::hstat(), FileLineIterator::hsta...
Definition: ql_file.dox.h:7
Qore::StatInfo::type
string type
a string giving the file type; one of: - "BLOCK-DEVICE" - "DIRECTORY" - "CHARACTER-DEVICE" - "...
Definition: ql_file.dox.h:35
Qore::StatInfo::ctime
date ctime
last change time of the file's inode
Definition: ql_file.dox.h:15
Qore::StatInfo::nlink
int nlink
number of hard links to this file
Definition: ql_file.dox.h:27
Qore::StatInfo::uid
int uid
user ID of the owner
Definition: ql_file.dox.h:37
Qore::StatInfo::rdev
int rdev
device type number
Definition: ql_file.dox.h:31
Qore::StatInfo::size
int size
file size in bytes
Definition: ql_file.dox.h:33
Qore::StatInfo::mtime
date mtime
last modified time of the file
Definition: ql_file.dox.h:25
Qore::StatInfo::perm
string perm
a string giving UNIX-style permissions for the file (ex: "-rwxr-xr-x")
Definition: ql_file.dox.h:29
Qore::StatInfo::inode
int inode
inode of the file
Definition: ql_file.dox.h:21
Qore::StatInfo::blksize
int blksize
block size; may be zero if the platform's internal stat() (2) function does not provide this info
Definition: ql_file.dox.h:11
Qore::StatInfo::gid
int gid
group ID of the owner
Definition: ql_file.dox.h:19
Qore::StatInfo::dev
int dev
device inode number the file is on
Definition: ql_file.dox.h:17
Qore::StatInfo::mode
int mode
inode protection mode
Definition: ql_file.dox.h:23
Qore::StatInfo::atime
date atime
last access time of the file
Definition: ql_file.dox.h:9
Qore::StatInfo::blocks
int blocks
blocks allocated for the file; may be zero if the platform's internal stat() (2) function does not pr...
Definition: ql_file.dox.h:13