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