Module dcanvas.core.files

Cross-platform file access utilities

Synopsis

import dcanvas.core.files;

Functions

NameDescription
appDataPath(subdir) Returns application data directory
appendPath(pathItems) Appends file path parts with proper delimiters e.g. appendPath("/home/user", ".myapp", "config") => "/home/user/.myapp/config"
appendPath(buf, pathItems) Appends file path parts with proper delimiters (as well converts delimiters inside path to system) to buffer e.g. appendPath("/home/user", ".myapp", "config") => "/home/user/.myapp/config"
convertPathDelimiters(buf) Converts path delimiters to standard for platform inplace in buffer(e.g. / to \ on windows, \ to / on posix), returns buf
convertPathDelimiters(src) Converts path delimiters to standard for platform (e.g. / to \ on windows, \ to / on posix)
exeFilename() Returns current executable path and file name
exePath() Returns current executable path only, including last path delimiter - removes executable name from result of std.file.thisExePath()
filterFilename(filename, pattern) check filename with pattern
filterFilename(filename, filters) Filters file name by pattern list
findExecutablePath(executableName) for executable name w/o path, find absolute path to executable
getBookmarkPaths() returns array of user bookmarked directories
getRootPaths() returns array of system root entries
homeEntry() Returns user's home directory entry
homePath() Returns user's home directory
isHidden(path) Check if path is hidden.
isPathDelimiter(ch) Returns true if char ch is / or \ slash
isRoot(path) returns true if directory is root directory (e.g. / or C:\\)
listDirectory(dir, attrFilter, filters) List directory content
listDirectory(dir, includeDirs, includeFiles, showHiddenFiles, filters, entries, showExecutables) List directory content
parentDir(path) returns parent directory for specified path
splitPath(path)
toAbsolutePath(pathName) if pathName is not absolute path, convert it to absolute (assuming it is relative to current directory)

Structs

NameDescription
RootEntry Filesystem root entry item

Enums

NameDescription
AttrFilter
RootEntryType Filesystem root entry / bookmark types

Manifest constants

NameTypeDescription
PATH_DELIMITER path delimiter (\ for windows, / for others)

Aliases

NameTypeDescription
currentDir std.file.getcwd Returns current directory