fs-accessor.hh

Go to the documentation of this file.

#pragma once
 
#include "lix/libutil/result.hh"
#include "lix/libutil/types.hh"
#include <kj/async.h>
 
namespace nix {

class FSAccessor
{
public:
    enum Type { tMissing, tRegular, tSymlink, tDirectory };
 
    struct Stat
    {
        Type type = tMissing;
        uint64_t fileSize = 0;
        bool isExecutable = false; // regular files only
        uint64_t narOffset = 0; // regular files only
    };
 
    virtual ~FSAccessor() { }
 
    virtual kj::Promise<Result<Stat>> stat(const Path & path) = 0;
 
    virtual kj::Promise<Result<StringSet>> readDirectory(const Path & path) = 0;

    virtual kj::Promise<Result<std::string>>
    readFile(const Path & path, bool requireValidPath = true) = 0;
 
    virtual kj::Promise<Result<std::string>> readLink(const Path & path) = 0;
};
 
}