xfs

func CopyFile ¶

func CopyFile(pathOrigin string, pathDestiny string) error

CopyFile duplicates the contents of a source file to a destination file. It automatically expands the tilde prefix ("~") on both file paths before execution. It creates the destination file if it does not exist, or opens it in append-mode if it does. Returns nil on success, or an error if path expansion fails, file opening operations are denied, the byte stream transfer fails, or the structural metadata cannot be flushed to disk.

func CreateDir ¶

func CreateDir(path string, perm ...os.FileMode) error

CreateDir creates a single directory at the specified path. It automatically expands the tilde prefix ("~") before creating the folder and fails if the parent directory structure does not exist. An optional os.FileMode can be passed; if omitted, it defaults to standard permissions (0755). Returns nil on success, or an error if path expansion fails or the directory cannot be created.

func CreateDirPath ¶

func CreateDirPath(path string, perm ...os.FileMode) error

CreateDirPath creates a directory path along with any necessary parent directories. It automatically expands the tilde prefix ("~") before creating the folder structure. An optional os.FileMode can be passed; if omitted, it defaults to standard permissions (0755). If the target path already exists, it does nothing and returns nil.

func CreateFile ¶

func CreateFile(path string, perm ...os.FileMode) (*os.File, error)

CreateFile creates a new file at the specified path, truncating it if it already exists. It automatically expands the tilde prefix ("~") before executing the operation. An optional os.FileMode can be passed; if omitted, it defaults to standard system permissions (0666). Returns a pointer to the opened file object (*os.File) ready for writing, or an error if path expansion or file creation fails.

func DeleteDir ¶

func DeleteDir(path string, recursive bool) error

DeleteDir removes a directory at the specified path, with optional recursive deletion of all its contents. It automatically expands the tilde prefix ("~") before executing any filesystem validation or removal steps. If recursive is true, it uses os.RemoveAll to forcefully delete the folder and everything inside it; otherwise, it uses os.Remove and fails if the directory is not completely empty. Returns nil on success, or an error if path expansion fails, the path is not a directory, or the system removal operation is denied.

func DeleteFile ¶

func DeleteFile(path string) error

DeleteFile removes a regular file at the specified path. It automatically expands the tilde prefix ("~") before performing the check and deletion. It explicitly fails if the targeted path is a directory to prevent accidental directory structural loss. Returns nil on success, or an error if path expansion fails, the path points to a directory, or the system removal operation is denied.

func Exists ¶

func Exists(path string) bool

Exists checks if a file or directory exists at the given path. It automatically expands the tilde prefix ("~") using the RetrieveFullPath function before executing the check. Returns true if the target path is found on the system, or false if it does not exist or if path expansion fails.

func ExportSetStatfsFunc ¶

func ExportSetStatfsFunc(fn func(string, interface{}) error) func()

ExportSetStatfsFunc allows tests to replace the underlying statfs implementation. The function accepts a callback with signature func(path string, buf interface{}) error where buf will be a *unix.Statfs_t. It returns a restore function.

func GetFileSize ¶

func GetFileSize(path string) (int64, error)

GetFileSize returns the size of the file in bytes at the specified path. It automatically expands the tilde prefix ("~") before checking the path. It explicitly returns an error if the path points to a directory or if the file does not exist. Returns the file size in bytes as an int64, or an error if path expansion, system calls, or validations fail.

func GetParentPath ¶

func GetParentPath(path string) (string, error)

GetParentPath extracts and returns the parent directory path from a given file path. It automatically expands the tilde prefix ("~") using the RetrieveFullPath function before isolating the layout. Returns the parent directory string, or an empty string if the input path is empty or if path expansion fails.

func GetPermission ¶

func GetPermission(path string) (os.FileMode, error)

GetPermission retrieves the system permission bits (os.FileMode) for the specified file or directory. It automatically expands the tilde prefix ("~") using the RetrieveFullPath function before executing the check. Returns the file mode permissions, or an error if path expansion fails or if the path does not exist.

func GetUserCacheDir ¶

func GetUserCacheDir() (string, error)

GetUserCacheDir returns the default root directory to use for user-specific cached data. Users should create their own application-specific subdirectory within this one and use that.

On Unix systems, it returns $XDG_CACHE_HOME as specified by https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.cache. On Darwin, it returns $HOME/Library/Caches. On Windows, it returns %LocalAppData%. On Plan 9, it returns $home/lib/cache.

If the location cannot be determined (for example, $HOME is not defined) or the path in $XDG_CACHE_HOME is relative, then it will return an error.

func GetUserConfigDir ¶

func GetUserConfigDir() (string, error)

GetUserConfigDir returns the default root directory to use for user-specific configuration data. Users should create their own application-specific subdirectory within this one and use that.

On Unix systems, it returns $XDG_CONFIG_HOME as specified by https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html if non-empty, else $HOME/.config. On Darwin, it returns $HOME/Library/Application Support. On Windows, it returns %AppData%. On Plan 9, it returns $home/lib.

If the location cannot be determined (for example, $HOME is not defined) or the path in $XDG_CONFIG_HOME is relative, then it will return an error.

func GetUserDataDir ¶

func GetUserDataDir() (string, error)

GetUserDataDir resolves the standard, platform-specific directory for persisting application data, strictly adhering to OS ecosystem conventions and specifications.

Behavior by platform:

• Windows: Prioritizes the "%LOCALAPPDATA%\Data" environment variable path. Falls back to "AppData\Local\Data" relative to the user's home directory if unset.
• Darwin (macOS): Returns the standard "Library/Application Support" directory as mandated by Apple's File System guidelines.
• Linux/Other: Strictly follows the XDG Base Directory Specification. It queries "$XDG_DATA_HOME" and falls back to the default "~/.local/share" directory.

It returns the absolute path without creating the directory on the file system. An error is returned if the user's home directory cannot be resolved.

func GetUserHomeDir ¶

func GetUserHomeDir() (string, error)

GetUserHomeDir returns the current user's home directory.

On Unix, including macOS, it returns the $HOME environment variable. On Windows, it returns %USERPROFILE%. On Plan 9, it returns the $home environment variable.

If the expected variable is not set in the environment, UserHomeDir returns either a platform-specific default value or a non-nil error.

func GetUserLogDir ¶

func GetUserLogDir() (string, error)

GetUserLogDir resolves the standard, platform-specific directory for storing application log files, ensuring compliance with each operating system's logging conventions.

Behavior by platform:

• Windows: Appends a "Logs" subdirectory to the "%LOCALAPPDATA%" environment path. Falls back to "AppData\Local\Logs" relative to the user's home directory if unset.
• Darwin (macOS): Returns the standard user-specific logging directory "~/Library/Logs" as defined by Apple's diagnostics and logging architecture.
• Linux/Other: Follows modern XDG extensions. It queries "$XDG_STATE_HOME" (falling back to "~/.local/state") as the primary logging path, and checks "$XDG_CACHE_HOME" ("~/.cache") as a secondary fallback.

It returns the absolute path without creating the directory on the file system. An error is returned if the user's home directory cannot be resolved.

func GetUserRuntimeDir ¶

func GetUserRuntimeDir() (string, error)

GetUserRuntimeDir resolves the standard, platform-specific directory for storing ephemeral runtime files, such as sockets, named pipes, process locks, or volatile session configs.

Behavior by platform:

• Windows: Appends a "Runtime" subdirectory to the "%LOCALAPPDATA%" environment path. Falls back to "AppData\Local\Runtime" relative to the user's home directory if unset.
• Darwin (macOS): Defaults to the OS-managed transient directory returned by os.TempDir(), suffixed with the application namespace, to match macOS ephemeral data policies.
• Linux/Other: Strictly follows the XDG Base Directory Specification. It queries "$XDG_RUNTIME_DIR" and falls back to the system's global temporary path via os.TempDir() if unset.

It returns the absolute path without creating the directory on the file system. An error is returned if the user's home directory cannot be resolved.

func GetUserStateDir ¶

func GetUserStateDir() (string, error)

GetUserStateDir resolves the standard, platform-specific directory for storing application state files, such as history, current session data, and non-critical logs.

Behavior by platform:

• Windows: Prioritizes the "%LOCALAPPDATA%\State" environment variable path. Falls back to "AppData\Local\State" relative to the user's home directory if unset.
• Darwin (macOS): Returns the standard "Library/Application Support" directory, aligning state persistence with Apple's bundle state and data conventions.
• Linux/Other: Strictly follows the XDG Base Directory Specification. It queries "$XDG_STATE_HOME" and falls back to the default "~/.local/state" directory.

It returns the absolute path without creating the directory on the file system. An error is returned if the user's home directory cannot be resolved.

func GetVolumeFreeSpace ¶

func GetVolumeFreeSpace(currentPath string, requiredBytes uint64) (bool, error)

GetVolumeFreeSpace calculates the available storage space on Linux, FreeBSD, or Dragonfly systems. It executes a native unix.Statfs system call to resolve active blocks and volume geometry.

func HasSpaceAvailable ¶

func HasSpaceAvailable(path string, requiredBytes uint64) (bool, error)

HasSpaceAvailable checks if the storage volume containing the specified path has at least the required number of bytes free. It accepts a filesystem path (path) and the minimum required space in bytes (requiredBytes). If the target path does not exist, it traverses upward to find the closest existing parent directory to accurately target the underlying volume. Returns true if the volume has sufficient space available for the current user, or false along with an error if the path expansion, UTF-16 conversion, or Win32 GetDiskFreeSpaceEx API call fails.

func IsDir ¶

func IsDir(path string) bool

IsDir checks if the specified path exists and points to a directory. It automatically expands the tilde prefix ("~") using the RetrieveFullPath function before executing the check. Returns true if the path is a directory, or false if it does not exist, is a regular file/symlink, or if system calls fail.

func IsEmptyDir ¶

func IsEmptyDir(path string) (bool, error)

IsEmptyDir checks if the specified directory exists and contains no files or subdirectories. It automatically expands the tilde prefix ("~") before evaluating the target directory path. Returns true if the directory is completely empty, or false along with an error if the path does not exist, is not a directory, or if read permissions are denied.

func IsFile ¶

func IsFile(path string) bool

IsFile checks if the specified path exists and points to a regular file. It automatically expands the tilde prefix ("~") using the RetrieveFullPath function before executing the check. Returns true if the path is a regular file, or false if it does not exist, is a directory/symlink, or if system calls fail.

func IsFileDirExists ¶

func IsFileDirExists(filePath string) bool

IsFileDirExists extracts the parent directory path from a given file path and checks if it exists as a valid directory. It automatically expands the tilde prefix ("~") before isolating the parent directory layout. Returns true if the parent directory structure exists on the system, or false if the path is empty, expansion fails, or the directory does not exist.

func IsReadable ¶

func IsReadable(path string) bool

IsReadable checks if the current application process has sufficient permissions to read the file or directory at the specified path. It automatically expands the tilde prefix ("~") and robustly handles both regular files and directory permission boundaries across different operating systems. Returns true if the path can be successfully read, or false if permissions are denied or if the path does not exist.

func IsSameFile ¶

func IsSameFile(pathA, pathB string) (bool, error)

IsSameFile checks if two different paths point to the exact same physical file or directory on the storage device. It automatically expands the tilde prefix ("~") on both inputs and resolves any symbolic links encountered. It relies on Go's native os.SameFile mechanism to compare low-level system identities like inodes or file IDs. Returns true if both paths target the identical filesystem resource, or false along with an error if metadata retrieval fails.

func IsWritable ¶

func IsWritable(path string) bool

IsWritable checks if the current application process has sufficient permissions to modify or write to the file or directory at the specified path. It automatically expands the tilde prefix ("~") and tests directories by attempting to create a temporary file inside them, or files by opening them in write-only append mode. Returns true if the path can be written to, or false if permissions are denied, if the path does not exist, or if the test operations fail.

func OpenFileRead ¶

func OpenFileRead(path string) (*os.File, error)

OpenFileRead opens an existing file exclusively in read-only mode. It automatically expands the tilde prefix ("~") using the RetrieveFullPath function before attempting to open the path. Returns a pointer to the opened file object (*os.File) ready for reading, or an error if path expansion fails or if the file does not exist.

func OpenFileWrite ¶

func OpenFileWrite(path string, truncate bool, perm ...os.FileMode) (*os.File, error)

OpenFileWrite opens a file for writing, creating it with the specified or default permissions (0644) if it does not exist. It automatically expands the tilde prefix ("~") before opening the path. If truncate is true, the file's existing content is cleared upon opening; otherwise, new data is appended to the end. An optional os.FileMode can be passed to override the default creation permissions. Returns a pointer to the opened file object (*os.File) ready for writing, or an error if path expansion or file opening fails.

func RetrieveFullPath ¶

func RetrieveFullPath(path string) (string, error)

RetrieveFullPath returns the fully resolved absolute path, or an error if system paths cannot be determined.

Replaces the tilde prefix ("~") with the user's home directory and strictly resolves the final result into a clean, absolute filesystem path. If the path is relative, it anchors it to the current working directory, removing any redundancies like "." or "..".

func SetPermission ¶

func SetPermission(path string, perm os.FileMode) error

SetPermission updates the filesystem permission bits (os.FileMode) for the specified file or directory. It automatically expands the tilde prefix ("~") using the RetrieveFullPath function before applying the changes. Returns nil on success, or an error if path expansion fails, the path does not exist, or the operation is denied.