The virtual file system interface.

Synopsis

Declared in <llvm/Support/VirtualFileSystem.h>

class FileSystem
    : public llvm::ThreadSafeRefCountedBase<FileSystem>
    , public RTTIExtends<FileSystem, RTTIRoot>

Base Classes

Name

Description

llvm::ThreadSafeRefCountedBase<FileSystem>

A thread‐safe version of RefCountedBase.

RTTIExtends<FileSystem, RTTIRoot>

Inheritance utility for extensible RTTI.

Type Aliases

Name

Description

VisitCallbackTy

Callback type used when visiting nested file systems.

Enums

Name

Description

PrintType

How much detail to include when printing a file system.

Member Functions

Name

Description

~FileSystem [destructor] [virtual]

Virtual destructor for polymorphic file systems.

Release

Atomically decrement the reference count; delete the object when it reaches zero.

Retain

Increment the reference count.

UseCount

Return the current reference count.

dir_begin [virtual]

Get a directory_iterator for Dir.

dump

Dump this file system to stderr for debugging.

equivalent

Check whether A and B refer to the same file.

exists [virtual]

Check whether Path exists. By default this uses status(), but filesystems may provide a more efficient implementation if available.

getBufferForFile

Open a file, read its contents, and close it.

getCurrentWorkingDirectory [virtual]

Get the working directory of this file system.

getRealPath [virtual]

Get the real path of Path.

isA

Check whether this instance is a subclass of QueryT.

isLocal [virtual]

Is the file mounted on a local filesystem?

makeAbsolute [virtual]

Make Path an absolute path.

openFileForRead [virtual]

Get a File object for the text file at Path, if one exists.

openFileForReadBinary [virtual]

Get a File object for the binary file at Path.

print

Print a description of this file system to OS.

setCurrentWorkingDirectory [virtual]

Set the working directory. This will affect all following operations on this file system and may propagate down for nested file systems.

status [virtual]

Get the status of the entry at Path, if one exists.

visit

Visit this file system and then its children.

visitChildFileSystems [virtual]

Visit nested child file systems.

Static Member Functions

Name

Description

classID

Return the static class ID for ThisT.

classof

Return true if R is an instance of ThisT (for Casting.h).

Static Data Members

Name

Description

ID

RTTI type identifier for this class.

Using Declarations

Name

Description

RTTIExtends

Inherit constructors from the first parent type.

Protected Member Functions

Name

Description

operator= [deleted]

Copy assignment is deleted; reference counts are not copied.

printImpl [virtual]

Print this file system implementation.

printIndent

Write indentation for file system printing.

Non-Member Functions

Name

Description

createPhysicalFileSystem

Create an vfs::FileSystem for the OS real file system.

getRealFileSystem

Get an vfs::FileSystem for the process's real file system.

getVFSFromYAML

Gets a FileSystem for a virtual file system described in YAML format.

Created with MrDocs