Represents file-system reader effects.

Since: 0.1

Type representing filenames/pathnames.

This type doesn't add any guarantees over OsString.

Search through the given list of directories for the given file.

The behavior is equivalent to findFileWith, returning only the first occurrence. Details can be found in the documentation of findFileWith.

Since: 0.1

Search through the given list of directories for the given file and returns all paths where the given file exists.

The behavior is equivalent to findFilesWith. Details can be found in the documentation of findFilesWith.

Since: 0.1

Retrieves the XDG data directory e.g. ~/.local/share.

Since: 0.1

Retrieves the XDG config directory e.g. ~/.config.

Since: 0.1

Retrieves the XDG cache directory e.g. ~/.cache.

Since: 0.1

Retrieves the XDG state directory e.g. ~/.local/state.

Since: 0.1

Path type.

Since: fs-utils-0.1

String representation of PathType.

Since: fs-utils-0.1

Returns the type for a given path without following symlinks. Throws IOException if the path does not exist or the type cannot be detected.

For a faster version in terms of PosixCompat, see effects-unix-compat.

Since: 0.1

Checks that the path type matches the expectation. Throws IOException if the path does not exist or the type cannot be detected.

For a faster version in terms of Posix(Compat), see effects-unix(-compat).

Since: 0.1

Throws IOException if the path does not exist or the expected path type does not match actual.

For a faster version in terms of Posix(Compat), see effects-unix(-compat).

Since: 0.1

Retrieves the recursive directory contents; splits the sub folders and directories apart.

Since: 0.1

Like listDirectoryRecursive except symbolic links are not traversed i.e. they are returned separately.

Since: 0.1

Returns true if the path is a symbolic link. Does not traverse the link.

Since: 0.1

Returns true if p is a symbolic link and it points to an extant directory. Throws an exception if the path is not a symbolic link or the target does not exist.

This function and pathIsSymbolicFileLink are intended to distinguish file and directory links on Windows. This matters for knowing when to use:

• createFileLink vs. createDirectoryLink
• removeFile vs. removeDirectoryLink

Suppose we want to copy an arbitrary path p. We first determine that p is a symlink via doesSymbolicLinkExist. If pathIsSymbolicDirectoryLink returns true then we know we should use Effects.FileSystem.PathWriter's createDirectoryLink. Otherwise we can fall back to createFileLink.

Because this relies on the symlink's target, this is best effort, and it is possible pathIsSymbolicDirectoryLink and pathIsSymbolicFileLink both return false.

Note that Posix makes no distinction between file and directory symbolic links. Thus if your system only has to work on Posix, you probably don't need this function.

Since: 0.1

Like pathIsSymbolicDirectoryLink but for files.

Since: 0.1

Special directories for storing user-specific application data, configuration, and cache files, as specified by the XDG Base Directory Specification.

Note: On Windows, XdgData and XdgConfig usually map to the same directory.

Since: directory-1.2.3.0

Search paths for various application data, as specified by the XDG Base Directory Specification.

The list of paths is split using searchPathSeparator, which on Windows is a semicolon.

Note: On Windows, XdgDataDirs and XdgConfigDirs usually yield the same result.

Since: directory-1.3.2.0

This is the simplest representation of UTC. It consists of the day number, and a time offset from midnight. Note that if a day has a leap second added to it, it will have 86401 seconds.