A file system that allows overlaying one AbstractFileSystem on top of another. More...

#include "llvm/Support/VirtualFileSystem.h"

Inheritance diagram for llvm::vfs::OverlayFileSystem:

[legend]

Public Types
using	iterator = FileSystemList::reverse_iterator

using	const_iterator = FileSystemList::const_reverse_iterator

using	reverse_iterator = FileSystemList::iterator

using	const_reverse_iterator = FileSystemList::const_iterator

using	range = iterator_range< iterator >

using	const_range = iterator_range< const_iterator >

Public Member Functions
	OverlayFileSystem (IntrusiveRefCntPtr< FileSystem > Base)

void	pushOverlay (IntrusiveRefCntPtr< FileSystem > FS)
	Pushes a file system on top of the stack.

llvm::ErrorOr< Status >	status (const Twine &Path) override

bool	exists (const Twine &Path) override

llvm::ErrorOr< std::unique_ptr< File > >	openFileForRead (const Twine &Path) override

directory_iterator	dir_begin (const Twine &Dir, std::error_code &EC) override

llvm::ErrorOr< std::string >	getCurrentWorkingDirectory () const override

std::error_code	setCurrentWorkingDirectory (const Twine &Path) override

std::error_code	isLocal (const Twine &Path, bool &Result) override

std::error_code	getRealPath (const Twine &Path, SmallVectorImpl< char > &Output) override

iterator	overlays_begin ()
	Get an iterator pointing to the most recently added file system.

const_iterator	overlays_begin () const

iterator	overlays_end ()
	Get an iterator pointing one-past the least recently added file system.

const_iterator	overlays_end () const

reverse_iterator	overlays_rbegin ()
	Get an iterator pointing to the least recently added file system.

const_reverse_iterator	overlays_rbegin () const

reverse_iterator	overlays_rend ()
	Get an iterator pointing one-past the most recently added file system.

const_reverse_iterator	overlays_rend () const

range	overlays_range ()

const_range	overlays_range () const

Public Member Functions inherited from llvm::RTTIExtends< OverlayFileSystem, FileSystem >
const void *	dynamicClassID () const override

bool	isA () const
	Check whether this instance is a subclass of QueryT.

bool	isA (const void *const ClassID) const override

Static Public Attributes
static const char	ID = 0

Protected Member Functions
void	printImpl (raw_ostream &OS, PrintType Type, unsigned IndentLevel) const override

void	visitChildFileSystems (VisitCallbackTy Callback) override

Additional Inherited Members
Static Public Member Functions inherited from llvm::RTTIExtends< OverlayFileSystem, FileSystem >
static const void *	classID ()

static bool	classof (const T *R)

Detailed Description

A file system that allows overlaying one AbstractFileSystem on top of another.

Consists of a stack of >=1 FileSystem objects, which are treated as being one merged file system. When there is a directory that exists in more than one file system, the OverlayFileSystem contains a directory containing the union of their contents. The attributes (permissions, etc.) of the top-most (most recently added) directory are used. When there is a file that exists in more than one file system, the file in the top-most file system overrides the other(s).

Definition at line 391 of file VirtualFileSystem.h.