Nix 2.26.3
Nix, the purely functional package manager; unstable internal interfaces
 
Loading...
Searching...
No Matches
nix::MemorySourceAccessor Struct Reference

#include <memory-source-accessor.hh>

Inheritance diagram for nix::MemorySourceAccessor:
nix::SourceAccessor

Classes

struct  File
 

Public Member Functions

bool operator== (const MemorySourceAccessor &) const noexcept=default
 
bool operator< (const MemorySourceAccessor &other) const noexcept
 
std::string readFile (const CanonPath &path) override
 
bool pathExists (const CanonPath &path) override
 
std::optional< StatmaybeLstat (const CanonPath &path) override
 
DirEntries readDirectory (const CanonPath &path) override
 
std::string readLink (const CanonPath &path) override
 
Fileopen (const CanonPath &path, std::optional< File > create)
 
SourcePath addFile (CanonPath path, std::string &&contents)
 
- Public Member Functions inherited from nix::SourceAccessor
virtual void readFile (const CanonPath &path, Sink &sink, std::function< void(uint64_t)> sizeCallback=[](uint64_t size){})
 
Stat lstat (const CanonPath &path)
 
virtual void dumpPath (const CanonPath &path, Sink &sink, PathFilter &filter=defaultPathFilter)
 
Hash hashPath (const CanonPath &path, PathFilter &filter=defaultPathFilter, HashAlgorithm ha=HashAlgorithm::SHA256)
 
virtual std::optional< std::filesystem::path > getPhysicalPath (const CanonPath &path)
 
bool operator== (const SourceAccessor &x) const
 
auto operator<=> (const SourceAccessor &x) const
 
void setPathDisplay (std::string displayPrefix, std::string displaySuffix="")
 
virtual std::string showPath (const CanonPath &path)
 
CanonPath resolveSymlinks (const CanonPath &path, SymlinkResolution mode=SymlinkResolution::Full)
 
virtual std::optional< time_t > getLastModified ()
 

Public Attributes

File root { File::Directory {} }
 
- Public Attributes inherited from nix::SourceAccessor
const size_t number
 
std::string displayPrefix
 
std::string displaySuffix
 
std::optional< std::string > fingerprint
 

Additional Inherited Members

- Public Types inherited from nix::SourceAccessor
enum  Type {
  tRegular , tSymlink , tDirectory , tChar ,
  tBlock , tSocket , tFifo , tUnknown
}
 
typedef std::optional< TypeDirEntry
 
typedef std::map< std::string, DirEntry > DirEntries
 

Detailed Description

An source accessor for an in-memory file system.

Member Function Documentation

◆ maybeLstat()

std::optional< MemorySourceAccessor::Stat > nix::MemorySourceAccessor::maybeLstat ( const CanonPath & path)
overridevirtual

Implements nix::SourceAccessor.

◆ open()

MemorySourceAccessor::File * nix::MemorySourceAccessor::open ( const CanonPath & path,
std::optional< File > create )
Parameters
createIf present, create this file and any parent directories that are needed.

Return null if

  • create = false: File does not exist.
  • create = true: some parent file was not a dir, so couldn't look/create inside.

◆ pathExists()

bool nix::MemorySourceAccessor::pathExists ( const CanonPath & path)
overridevirtual

Reimplemented from nix::SourceAccessor.

◆ readDirectory()

MemorySourceAccessor::DirEntries nix::MemorySourceAccessor::readDirectory ( const CanonPath & path)
overridevirtual
Note
Like readFile, this method should not follow symlinks.

Implements nix::SourceAccessor.

◆ readFile()

std::string nix::MemorySourceAccessor::readFile ( const CanonPath & path)
overridevirtual

Return the contents of a file as a string.

Note
Unlike Unix, this method should not follow symlinks. Nix by default wants to manipulate symlinks explicitly, and not implictly follow them, as they are frequently untrusted user data and thus may point to arbitrary locations. Acting on the targets targets of symlinks should only occasionally be done, and only with care.

Reimplemented from nix::SourceAccessor.

◆ readLink()

std::string nix::MemorySourceAccessor::readLink ( const CanonPath & path)
overridevirtual

Implements nix::SourceAccessor.


The documentation for this struct was generated from the following files: