file-system.hh

Go to the documentation of this file.

#pragma once
#include "lix/libutil/async-io.hh"
#include "lix/libutil/box_ptr.hh"
#include "lix/libutil/types.hh"
#include "lix/libutil/file-descriptor.hh"
 
#include <sys/types.h>
#include <sys/stat.h>
#include <dirent.h>
#include <unistd.h>
 
#include <functional>
#include <optional>
 
#ifndef HAVE_STRUCT_DIRENT_D_TYPE
#define DT_UNKNOWN 0
#define DT_REG 1
#define DT_LNK 2
#define DT_DIR 3
#endif
 
namespace nix {
 
struct Sink;
struct Source;
 
Path getCwd();
 
Path absPath(Path path,
    std::optional<PathView> dir = {},
    bool resolveSymlinks = false);
 
Path canonPath(PathView path, bool resolveSymlinks = false);
 
Path realPath(Path const & path);
 
Path tildePath(Path const & path, const std::optional<Path> & home = std::nullopt);
 
void chmodPath(const Path & path, mode_t mode);
 
Path dirOf(const PathView path);
 
std::string_view baseNameOf(std::string_view path);
 
std::string expandTilde(std::string_view path);
 
bool isInDir(std::string_view path, std::string_view dir);
 
bool isDirOrInDir(std::string_view path, std::string_view dir);
 
struct stat stat(const Path & path);
struct stat lstat(const Path & path);
 
std::optional<struct stat> maybeStat(const Path & path);
 
std::optional<struct stat> maybeLstat(const Path & path);
 
bool pathExists(const Path & path);
 
bool pathAccessible(const Path & path, bool resolveSymlinks = false);
 
Path readLink(const Path & path);
 
bool isLink(const Path & path);
 
struct DirEntry
{
    std::string name;
    ino_t ino;
    unsigned char type;
    DirEntry(std::string name, ino_t ino, unsigned char type)
        : name(std::move(name)), ino(ino), type(type) { }
};
 
typedef std::vector<DirEntry> DirEntries;
 
DirEntries readDirectory(const Path & path);
 
unsigned char getFileType(const Path & path);
 
std::string readFile(const Path & path);
Generator<Bytes> readFileSource(const Path & path);
 
void writeFile(const Path & path, std::string_view s, mode_t mode = 0666, bool sync = false);
 
void writeFile(const Path & path, Source & source, mode_t mode = 0666, bool sync = false);
kj::Promise<Result<void>>
writeFile(const Path & path, AsyncInputStream & source, mode_t mode = 0666, bool sync = false);
 
void syncParent(const Path & path);
 
void deletePath(const Path & path);
void deletePathUninterruptible(const Path & path);
 
void deletePath(const Path & path, uint64_t & bytesFreed);
 
Paths createDirs(const Path & path);
inline Paths createDirs(PathView path)
{
    return createDirs(Path(path));
}
 
void createSymlink(const Path & target, const Path & link);
 
void replaceSymlink(const Path & target, const Path & link);
 
void renameFile(const Path & src, const Path & dst);
 
void moveFile(const Path & src, const Path & dst);
 
struct CopyFileFlags
{
    bool deleteAfter = false;
 
    bool followSymlinks = false;
};
 
void copyFile(const Path & oldPath, const Path & newPath, CopyFileFlags flags);
 
class AutoDelete
{
    Path path;
    bool del;
    bool recursive;
public:
    AutoDelete();
    AutoDelete(const Path & p, bool recursive = true);
    ~AutoDelete();
    void cancel();
    void reset(const Path & p, bool recursive = true);
    operator Path() const { return path; }
    operator PathView() const { return path; }
};
 
struct DIRDeleter
{
    void operator()(DIR * dir) const {
        closedir(dir);
    }
};
 
typedef std::unique_ptr<DIR, DIRDeleter> AutoCloseDir;
 
Path createTempSubdir(const Path & parent, const Path & prefix = "nix",
    bool includePid = true, bool useGlobalCounter = true, mode_t mode = 0755);
 
Path makeTempPath(const Path & root, const Path & suffix = ".tmp");
 
typedef std::function<bool(const Path & path)> PathFilter;
 
extern PathFilter defaultPathFilter;
 
}