| Qore Programming Language Reference Manual 1.0.8

ql_file.dox.h
1
3 namespace Qore {
5
7 struct StatInfo {
9 date atime;
11 int blksize;
13 int blocks;
15 date ctime;
17 int dev;
19 int gid;
21 int inode;
23 int mode;
25 date mtime;
27 int nlink;
29 string perm;
31 int rdev;
33 int size;
35 string type;
37 int uid;
38 };
39 }
40
42 namespace Qore {
44
46 struct FilesystemInfo {
48 int bavail;
50 int bfree;
52 int blocks;
54 int bsize;
56 int favail;
58 int ffree;
60 int files;
62 int frsize;
64 int fsid;
66 int namemax;
67 };
68 }
69
71 namespace Qore {
156
175 bool absolute_path(string path);
176
178
196 bool absolute_path_unix(string path);
197
199
217 bool absolute_path_windows(string path);
218
220
235 int chdir(string path);
236
238
252 int chmod(string path, softint mode);
253
255
276 int chown(string path, softint owner = -1, softint group = -1);
277
279
294 *string getcwd();
295
297
310 string getcwd2();
311
313
327 *list<string> glob(string glob_str);
328
330
337 nothing glob();
338
340
358 *hash<StatInfo> hlstat(string path);
359
361
368 nothing hlstat();
369
371
389 *hash<StatInfo> hstat(string path);
390
392
399 nothing hstat();
400
402
417 bool is_bdev(string path);
418
420
435 bool is_cdev(string path);
436
438
453 bool is_dev(string path);
454
456
471 bool is_dir(string path);
472
474
493 bool is_executable(string path);
494
496
511 bool is_file(string path);
512
514
533 bool is_link(string path);
534
536
551 bool is_pipe(string path);
552
554
569 bool is_readable(string path);
570
572
591 bool is_socket(string path);
592
594
611 bool is_writable(string path);
612
614
631 bool is_writeable(string path);
632
634
655 int lchown(string path, softint uid = -1, softint gid = -1);
656
658
677 *list<auto> lstat(string path);
678
680
687 nothing lstat();
688
690
715 int mkdir(string path, softint mode = 0777, bool parents = False);
716
718
737 nothing mkdir_ex(string path, softint mode = 0777, bool parents = False);
738
740
758 int mkfifo(string path, softint mode = 0600);
759
761
779 string readlink(string path);
780
782
798 string realpath(string path);
799
801
818 nothing rename(string old_path, string new_path);
819
821
836 int rmdir(string path);
837
839
857 *list<auto> stat(string path);
858
860
867 nothing stat();
868
870
888 *hash<FilesystemInfo> statvfs(string path);
889
891
913 nothing symlink(string old_path, string new_path);
914
916
929 int umask(softint mask);
930
932
939 nothing umask();
940
942
957 int unlink(string path);
958
960
967 nothing unlink();
968
970 }
Qore::FilesystemInfo::files
int files
The total number of inodes on the filesystem.
Definition: ql_file.dox.h:60
Qore::StatInfo
file status information hash as returned from hstat(), hlstat(), Dir::hstat(), FileLineIterator::hsta...
Definition: ql_file.dox.h:7
Qore::rename
nothing rename(string old_path, string new_path)
Renames (or moves) files or directories. Note that for this call to function properly, the Qore process must have sufficient permissions and access to the given filesystem objects or paths to execute the rename operation.
Qore::date
date date(date dt)
Returns the date passed.
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::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::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::chmod
int chmod(string path, softint mode)
Changes the mode of a file or directory.
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::size
int size
file size in bytes
Definition: ql_file.dox.h:33
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::is_pipe
bool is_pipe(string path)
Returns True if the string passed identifies a pipe (FIFO) on the filesystem, False if not...
Qore::getcwd
*string getcwd()
Returns a string giving the current working directory or NOTHING if the current working directory cou...
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::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::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::blksize
int blksize
block size; may be zero if the platform&#39;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::False
const False
logical False
Definition: qc_qore.dox.h:96
Qore::is_cdev
bool is_cdev(string path)
Returns True if the string passed identifies a character device on the filesystem, False if not.
Qore::absolute_path_unix
bool absolute_path_unix(string path)
returns True if the argument is a UNIX absolute path, False if not
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, the Qore process must have sufficient permissions and access to the given filesystem path to create the symbolic link.
Qore::hstat
*hash< StatInfo > hstat(string path)
Returns a StatInfo hash for the path argument, following any symbolic links; if any errors occur...
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::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::mkdir
int mkdir(string path, softint mode=0777, bool parents=False)
Creates a directory, optionally specifying the mode.
Qore::StatInfo::ctime
date ctime
last change time of the file&#39;s inode
Definition: ql_file.dox.h:15
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::statvfs
*hash< FilesystemInfo > statvfs(string path)
Returns a hash of filesystem status values for the file or directory path passed. ...
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::umask
int umask(softint mask)
Sets the file creation mode mask for the process and returns the previous value of the file creation ...
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::is_executable
bool is_executable(string path)
Returns True if the string passed identifies an executable on the filesystem, False if not...
Qore::FilesystemInfo::ffree
int ffree
The total number of free inodes available to privileged users.
Definition: ql_file.dox.h:58
Qore::is_dir
bool is_dir(string path)
Returns True if the string passed identifies a directory 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::chdir
int chdir(string path)
Changes the current working directory for the current process.
Qore::FilesystemInfo::namemax
int namemax
The maximum length in bytes of file names on the filesystem.
Definition: ql_file.dox.h:66
Qore::StatInfo::nlink
int nlink
number of hard links to this file
Definition: ql_file.dox.h:27
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_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::bsize
int bsize
The filesystem&#39;s block size.
Definition: ql_file.dox.h:54
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::bavail
int bavail
The number of free blocks available to unprivileged users (bytes = bsize * bavail) ...
Definition: ql_file.dox.h:48
Qore::rmdir
int rmdir(string path)
Removes a directory.
Qore::FilesystemInfo::favail
int favail
The number of free inodes available to unprivileged users.
Definition: ql_file.dox.h:56
Qore::StatInfo::mtime
date mtime
last modified time of the file
Definition: ql_file.dox.h:25
Qore::StatInfo::dev
int dev
device inode number the file is on
Definition: ql_file.dox.h:17
Qore::StatInfo::atime
date atime
last access time of the file
Definition: ql_file.dox.h:9
Qore::mkfifo
int mkfifo(string path, softint mode=0600)
Creates a named pipe file with an optional file mode.
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::StatInfo::blocks
int blocks
blocks allocated for the file; may be zero if the platform&#39;s internal stat() (2) function does not pr...
Definition: ql_file.dox.h:13
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::is_bdev
bool is_bdev(string path)
Returns True if the string passed identifies a block device 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
main Qore-language namespace
Definition: Pseudo_QC_All.dox.h:3
Qore::StatInfo::mode
int mode
inode protection mode
Definition: ql_file.dox.h:23
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::StatInfo::uid
int uid
user ID of the owner
Definition: ql_file.dox.h:37
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::absolute_path_windows
bool absolute_path_windows(string path)
returns True if the argument is a Windows absolute path, False if not
Qore::FilesystemInfo
Filesystem info hash as returned by statvfs, Dir::statvfs, and ReadOnlyFile::statvfs()".
Definition: ql_file.dox.h:46
Qore::getcwd2
string getcwd2()
Returns a string giving the current working directory; throws an exception if the current directory c...
Qore::StatInfo::rdev
int rdev
device type number
Definition: ql_file.dox.h:31
Qore::absolute_path
bool absolute_path(string path)
returns True if the argument is an absolute path on the current platform, False if not ...