llvm::MemoryBuffer::getOpenFile

Given an already-open file descriptor, read the file and return a MemoryBuffer.

Synopsis

Declared in <llvm/Support/MemoryBuffer.h>

static
ErrorOr<std::unique_ptr<MemoryBuffer>>
getOpenFile(
    sys::fs::file_t FD,
    Twine const& Filename,
    uint64_t FileSize,
    bool RequiresNullTerminator = true,
    bool IsVolatile = false,
    std::optional<Align> Alignment = std::nullopt);

Return Value

The file contents on success, or an error on failure.

Parameters

NameDescription
FDAlready-open file descriptor to read from.
FilenameIdentifier for the buffer (typically the path).
FileSizeSize of the file in bytes.
RequiresNullTerminatorWhether the buffer must be null-terminated.
IsVolatileSet to true to indicate that the contents of the file can change outside the user's control, e.g. when libclang tries to parse while the user is editing/updating the file or if the file is on an NFS.
AlignmentSet to indicate that the buffer should be aligned to at least the specified alignment.