Models a file path. These are expected to be used as the constructor
argument to various file classes. The intention is that they easily
convert to other representations such as absolute, canonical, or Url.
File paths containing non-ansi characters should be UTF-8 encoded.
Supporting Unicode in this manner was deemed to be more suitable
than providing a wchar version of FilePath, and is both consistent
& compatible with the approach taken with the Uri class.
- alias bool delegate (FilePath, bool) Filter [public] ¶#
-
Filter used for screening paths via toList()
- FilePath opCall(char[] filepath = null) [static] ¶#
-
Call-site shortcut to create a FilePath instance. This
enables the same syntax as struct usage, so may expose
a migration path
- this(char[] filepath = null) ¶#
-
Create a FilePath from a copy of the provided string.
FilePath assumes both path & name are present, and therefore
may split what is otherwise a logically valid path. That is,
the 'name' of a file is typically the path segment following
a rightmost path-separator. The intent is to treat files and
directories in the same manner; as a name with an optional
ancestral structure. It is possible to bias the interpretation
by adding a trailing path-separator to the argument. Doing so
will result in an empty name attribute.
With regard to the filepath copy, we found the common case to
be an explicit .dup, whereas aliasing appeared to be rare by
comparison. We also noted a large proportion interacting with
C-oriented OS calls, implying the postfix of a null terminator.
Thus, FilePath combines both as a single operation.
Note that Win32 '\' characters are normalized to '/' instead.
- char[] toString() [final] ¶#
-
Return the complete text of this filepath
- FilePath dup() [final] ¶#
-
Duplicate this path
- char[] cString() [final] ¶#
-
Return the complete text of this filepath as a null
terminated string for use with a C api. Use toString
instead for any D api.
Note that the nul is always embedded within the string
maintained by FilePath, so there's no heap overhead when
making a C call
- char[] root() [final] ¶#
-
Return the root of this path. Roots are constructs such as
"c:"
- char[] folder() [final] ¶#
-
Return the file path. Paths may start and end with a "/".
The root path is "/" and an unspecified path is returned as
an empty string. Directory paths may be split such that the
directory name is placed into the 'name' member; directory
paths are treated no differently than file paths
- char[] parent() [final] ¶#
-
Returns a path representing the parent of this one. This
will typically return the current path component, though
with a special case where the name component is empty. In
such cases, the path is scanned for a prior segment:
1
2
| normal: /x/y/z => /x/y
special: /x/y/ => /x
|
- char[] name() [final] ¶#
-
Return the name of this file, or directory.
- char[] ext() [final] ¶#
-
Ext is the tail of the filename, rightward of the rightmost
'.' separator e.g. path "foo.bar" has ext "bar". Note that
patterns of adjacent separators are treated specially; for
example, ".." will wind up with no ext at all
- char[] suffix() [final] ¶#
-
Suffix is like ext, but includes the separator e.g. path
"foo.bar" has suffix ".bar"
- char[] path() [final] ¶#
-
return the root + folder combination
- char[] file() [final] ¶#
-
return the name + suffix combination
- int opEquals(Object o) [override, final] ¶#
-
Returns true if all fields are equal.
- int opEquals(char[] s) [final] ¶#
-
Does this FilePath equate to the given text?
- bool isAbsolute() [final] ¶#
-
Returns true if this FilePath is *not* relative to the
current working directory
- bool isEmpty() [final] ¶#
-
Returns true if this FilePath is empty
- bool isChild() [final] ¶#
-
Returns true if this FilePath has a parent. Note that a
parent is defined by the presence of a path-separator in
the path. This means 'foo' within "\foo" is considered a
child of the root
- FilePath replace(char from, char to) [final] ¶#
-
Replace all 'from' instances with 'to'
- FilePath standard() [final] ¶#
-
Convert path separators to a standard format, using '/' as
the path separator. This is compatible with URI and all of
the contemporary O/S which Tango supports. Known exceptions
include the Windows command-line processor, which considers
'/' characters to be switches instead. Use the native()
method to support that.
mutates the current path.
- FilePath native() [final] ¶#
-
Convert to native O/S path separators where that is required,
such as when dealing with the Windows command-line.
mutates the current path. Use this pattern to obtain a
copy instead: path.dup.native
- FilePath cat(char[][] others...) [final] ¶#
-
Concatenate text to this path; no separators are added.
See join() also
- FilePath append(char[] path) [final] ¶#
-
Append a folder to this path. A leading separator is added
as required
- FilePath prepend(char[] path) [final] ¶#
-
Prepend a folder to this path. A trailing separator is added
if needed
- FilePath set(FilePath path) ¶#
-
Reset the content of this path to that of another and
reparse
- FilePath set(char[] path, bool convert = false) [final] ¶#
-
Reset the content of this path, and reparse. There's an
optional boolean flag to convert the path into standard
form, before parsing (converting '\' into '/')
- FilePath isFolder(bool folder) [final] ¶#
-
Sidestep the normal lookup for paths that are known to
be folders. Where folder is true, file-system lookups
will be skipped.
- FilePath root(char[] other) [final] ¶#
-
Replace the root portion of this path
- FilePath folder(char[] other) [final] ¶#
-
Replace the folder portion of this path. The folder will be
padded with a path-separator as required
- FilePath name(char[] other) [final] ¶#
-
Replace the name portion of this path
- FilePath suffix(char[] other) [final] ¶#
-
Replace the suffix portion of this path. The suffix will be
prefixed with a file-separator as required
- FilePath path(char[] other) [final] ¶#
-
Replace the root and folder portions of this path and
reparse. The replacement will be padded with a path
separator as required
- FilePath file(char[] other) [final] ¶#
-
Replace the file and suffix portions of this path and
reparse. The replacement will be prefixed with a suffix
separator as required
- FilePath pop() [final] ¶#
-
Pop to the parent of the current filepath (in situ - mutates
this FilePath)
- char[] join(char[][] paths...) [static] ¶#
-
Join a set of path specs together. A path separator is
potentially inserted between each of the segments.
- FilePath absolute(char[] prefix) [final] ¶#
-
Convert this FilePath to absolute format, using the given
prefix as necessary. If this FilePath is already absolute,
return it intact.
Returns this FilePath, adjusted as necessary
- char[] stripped(char[] path, char c = FileConst.PathSeparatorChar) [static] ¶#
-
Return an adjusted path such that non-empty instances do not
have a trailing separator
- char[] padded(char[] path, char c = FileConst.PathSeparatorChar) [static] ¶#
-
Return an adjusted path such that non-empty instances always
have a trailing separator
- char[] prefixed(char[] s, char c = FileConst.PathSeparatorChar) [static] ¶#
-
Return an adjusted path such that non-empty instances always
have a prefixed separator
- FilePath parse() [private, final] ¶#
-
Parse the path spec, and mutate '\' into '/' as necessary
- void expand(uint size) [private, final] ¶#
-
Potentially make room for more content
- int adjust(int head, int tail, int len, char[] sub) [private, final] ¶#
-
Insert/delete internal content
- FilePath create() [final] ¶#
-
file-system methods
Create an entire path consisting of this folder along with
all parent folders. The path must not contain '.' or '..'
segments. Related methods include PathUtil.normalize() and
absolute()
Note that each segment is created as a folder, including the
trailing segment.
a chaining reference (this)
IOException upon systen errors
IllegalArgumentException if a segment exists but as
a file instead of a folder
- FilePath[] toList(Filter filter = null) [final] ¶#
-
List the set of filenames within this folder, using
the provided filter to control the list:
1
| bool delegate (FilePath path, bool isFolder) Filter
|
- FilePath from(ref FileInfo info) [static] ¶#
-
Construct a FilePath from the given FileInfo
- bool exists() [final] ¶#
-
Does this path currently exist?
- Time modified() [final] ¶#
-
Returns the time of the last modification. Accurate
to whatever the OS supports, and in a format dictated
by the file-system. For example NTFS keeps UTC time,
while FAT timestamps are based on the local time.
- Time accessed() [final] ¶#
-
Returns the time of the last access. Accurate to
whatever the OS supports, and in a format dictated
by the file-system. For example NTFS keeps UTC time,
while FAT timestamps are based on the local time.
- Time created() [final] ¶#
-
Returns the time of file creation. Accurate to
whatever the OS supports, and in a format dictated
by the file-system. For example NTFS keeps UTC time,
while FAT timestamps are based on the local time.
- FilePath rename(FilePath dst) [final] ¶#
-
change the name or location of a file/directory, and
adopt the provided Path
- FilePath copy(char[] source) [final] ¶#
-
Transfer the content of another file to this one. Returns a
reference to this class on success, or throws an IOException
upon failure.
- ulong fileSize() [final] ¶#
-
Return the file length (in bytes)
- bool isWritable() [final] ¶#
-
Is this file writable?
- bool isFolder() [final] ¶#
-
Is this file actually a folder/directory?
- bool isFile() [final] ¶#
-
Is this a regular file?
- Stamps timeStamps() [final] ¶#
-
Return timestamp information
Timstamps are returns in a format dictated by the
file-system. For example NTFS keeps UTC time,
while FAT timestamps are based on the local time
- FilePath copy(FilePath src) [final] ¶#
-
Transfer the content of another file to this one. Returns a
reference to this class on success, or throws an IOException
upon failure.
- FilePath remove() [final] ¶#
-
Remove the file/directory from the file-system
- FilePath rename(char[] dst) [final] ¶#
-
change the name or location of a file/directory, and
adopt the provided Path
- FilePath createFile() [final] ¶#
-
Create a new file
- FilePath createFolder() [final] ¶#
-
Create a new directory
- int opApply(int delegate(ref FileInfo) dg) [final] ¶#
-
List the set of filenames within this folder.
Each path and filename is passed to the provided
delegate, along with the path prefix and whether
the entry is a folder or not.
Returns the number of files scanned.