slang::BufferID struct

#include <slang/text/SourceLocation.h>

BufferID - Represents a source buffer.

Buffers can either be source code loaded from a file, assigned from text in memory, or they can represent a macro expansion. Each time a macro is expanded a new BufferID is allocated to track the expansion location and original definition location.

Public static functions

static BufferID getPlaceholder()

Constructors, destructors, conversion operators

operator bool() const explicit

Public functions

bool valid() const

uint32_t getId() const constexpr

Function documentation

static BufferID slang::BufferID::getPlaceholder()

Returns	a placeholder buffer ID. It should be used only for locations where the buffer doesn't actually matter and won't be observed.

slang::BufferID::operator bool() const explicit

Returns	true if the ID is for a valid buffer, and false if not.

bool slang::BufferID::valid() const

Returns	true if the ID is for a valid buffer, and false if not.

uint32_t slang::BufferID::getId() const constexpr

Returns	an integer representing the raw buffer ID.