1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
/*
* Copyright (C)2005-2012 Haxe Foundation
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
package sys;
/**
This class allows you to get information about the files and directories.
See `sys.io.File` for the complementary file API.
**/
extern class FileSystem {
/**
Tells if the file or directory specified by `path` exists.
If `path` is null, the result is unspecified.
**/
static function exists( path : String ) : Bool;
/**
Renames/moves the file or directory specified by `path` to `newPath`.
If `path` is not a valid file system entry, or if it is not accessible,
or if `newPath` is not accessible, an exception is thrown.
If `path` or `newPath` are null, the result is unspecified.
**/
static function rename( path : String, newPath : String ) : Void;
/**
Returns `FileStat` information on the file or directory specified by
`path`.
If `path` is null, the result is unspecified.
**/
static function stat( path : String ) : FileStat;
/**
Returns the full path of the file or directory specified by `relPath`,
which is relative to the current working directory. Symlinks will be
followed and the path will be normalized.
If `relPath` is null, the result is unspecified.
**/
static function fullPath( relPath : String ) : String;
/**
Returns the full path of the file or directory specified by `relPath`,
which is relative to the current working directory. The path doesn't
have to exist.
If `relPath` is null, the result is unspecified.
**/
//@:require(haxe_ver >= 3.2)
static function absolutePath( relPath : String ) : String;
/**
Tells if the file or directory specified by `path` is a directory.
If `path` is not a valid file system entry or if its destination is no
accessible, an exception is thrown.
If `path` is null, the result is unspecified.
**/
static function isDirectory( path : String ) : Bool;
/**
Creates a directory specified by `path`.
This method is recursive: The parent directories don't have to exist.
If the directory cannot be created, an exception is thrown.
If `path` is null, the result is unspecified.
**/
static function createDirectory( path : String ) : Void;
/**
Deletes the file specified by `path`.
If `path` does not denote a valid file, or if that file cannot be
deleted, an exception is thrown.
If `path` is null, the result is unspecified.
**/
static function deleteFile( path : String ) : Void;
/**
Deletes the directory specified by `path`.
If `path` does not denote a valid directory, or if that directory cannot
be deleted, an exception is thrown.
If `path` is null, the result is unspecified.
**/
static function deleteDirectory( path : String ) : Void;
/**
Returns the names of all files and directories in the directory specified
by `path`.
If `path` does not denote a valid directory, an exception is thrown.
If `path` is null, the result is unspecified.
**/
static function readDirectory( path : String ) : Array<String>;
}
|
