API - Docs - AsmJit

Index ⭢ Utilities ⭢ asmjit::String

asmjit::String Class Reference

Inheritance diagram for asmjit::String:

A simple non-reference counted string that uses small string optimization (SSO).

This string has 3 allocation possibilities:

Small - embedded buffer is used for up to kSSOCapacity characters. This should handle most small strings and thus avoid dynamic memory allocation for most use-cases.
Large - string that doesn't fit into an embedded buffer (or string that was truncated from a larger buffer) and is owned by AsmJit. When you destroy the string AsmJit would automatically release the large buffer.
External - like Large (2), however, the large buffer is not owned by AsmJit and won't be released when the string is destroyed or reallocated. This is mostly useful for working with larger temporary strings allocated on stack or with immutable strings.

Public Types

enum class ModifyOp : uint32_t

Member Functions

String(const String& other) = delete

String& operator=(const String& other) = delete

Construction & Destruction

String() noexcept

String(String&& other) noexcept

~String() noexcept

Error reset() noexcept

Overloaded Operators

String& operator=(String&& other) noexcept

bool operator==(const char* other) const noexcept

bool operator!=(const char* other) const noexcept

bool operator==(const String& other) const noexcept

bool operator!=(const String& other) const noexcept

Accessors

bool isExternal() const noexcept

bool isLargeOrExternal() const noexcept

bool empty() const noexcept

size_t size() const noexcept

size_t capacity() const noexcept

char* data() noexcept

const char* data() const noexcept

char* start() noexcept

const char* start() const noexcept

char* end() noexcept

const char* end() const noexcept

String Operations

void swap(String& other) noexcept

Error clear() noexcept

char* prepare(ModifyOp op, size_t size) noexcept

Error _opString(ModifyOp op, const char* str, size_t size = SIZE_MAX) noexcept

Error _opChar(ModifyOp op, char c) noexcept

Error _opChars(ModifyOp op, char c, size_t n) noexcept

Error _opNumber(ModifyOp op, uint64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone) noexcept

Error _opHex(ModifyOp op, const void* data, size_t size, char separator = '\0') noexcept

Error _opFormat(ModifyOp op, const char* fmt, ...) noexcept

Error _opVFormat(ModifyOp op, const char* fmt, va_list ap) noexcept

Error assign(const char* data, size_t size = SIZE_MAX) noexcept

Error assign(const String& other) noexcept

Error assign(char c) noexcept

Error assignChars(char c, size_t n) noexcept

Error assignInt(int64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone) noexcept

Error assignUInt(uint64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone) noexcept

Error assignHex(const void* data, size_t size, char separator = '\0') noexcept

template<typename... Args>

Error assignFormat(const char* fmt, Args&&... args) noexcept

Error assignVFormat(const char* fmt, va_list ap) noexcept

Error append(const char* str, size_t size = SIZE_MAX) noexcept

Error append(const String& other) noexcept

Error append(char c) noexcept

Error appendChars(char c, size_t n) noexcept

Error appendInt(int64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone) noexcept

Error appendUInt(uint64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone) noexcept

Error appendHex(const void* data, size_t size, char separator = '\0') noexcept

template<typename... Args>

Error appendFormat(const char* fmt, Args&&... args) noexcept

Error appendVFormat(const char* fmt, va_list ap) noexcept

Error padEnd(size_t n, char c = ' ') noexcept

Error truncate(size_t newSize) noexcept

bool equals(const char* other, size_t size = SIZE_MAX) const noexcept

bool equals(const String& other) const noexcept

Internal Functions

void _resetInternal() noexcept

void _setSize(size_t newSize) noexcept

class String::ModifyOp : uint32_tenumstrong[¶]

String operation.

Constant	Description
kAssign	Assignment - a new content replaces the current one.
kAppend	Append - a new content is appended to the string.

String::String()noexcept[1/2][¶]

Creates a default-initialized string if zero length.

String::String(
String&& other
)noexcept[2/2][¶]

Creates a string that takes ownership of the content of the other string.

Error String::reset()noexcept[¶]

Reset the string into a construction state.

bool String::empty() constnoexcept[¶]

Tests whether the string is empty.

size_t String::size() constnoexcept[¶]

Returns the size of the string.

size_t String::capacity() constnoexcept[¶]

Returns the capacity of the string.

char* String::data()noexcept[1/2][¶]

Returns the data of the string.

const char* String::data() constnoexcept[2/2][¶]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void String::swap(
String& other
)noexcept[¶]

Swaps the content of this string with other.

Error String::clear()noexcept[¶]

Clears the content of the string.

Error String::assign(
const char* data,
size_t size = SIZE_MAX
)noexcept[1/3][¶]

Replaces the current of the string with data of the given size.

Null terminated strings can set size to SIZE_MAX.

Error String::assign(
const String& other
)noexcept[2/3][¶]

Replaces the current of the string with other string.

Error String::assign(
char c
)noexcept[3/3][¶]

Replaces the current of the string by a single c character.

Error String::assignChars(
char c,
size_t n
)noexcept[¶]

Replaces the current of the string by a c character, repeated n times.

Error String::assignInt(
int64_t i,
uint32_t base = 0,
size_t width = 0,
StringFormatFlags flags = StringFormatFlags::kNone
)noexcept[¶]

Replaces the current of the string by a formatted integer i (signed).

Error String::assignUInt(
uint64_t i,
uint32_t base = 0,
size_t width = 0,
StringFormatFlags flags = StringFormatFlags::kNone
)noexcept[¶]

Replaces the current of the string by a formatted integer i (unsigned).

Error String::assignHex(
const void* data,
size_t size,
char separator = '\0'
)noexcept[¶]

Replaces the current of the string by the given data converted to a HEX string.

template<typename... Args>
Error String::assignFormat(
const char* fmt,
Args&&... args
)noexcept[¶]

Replaces the current of the string by a formatted string fmt.

Error String::assignVFormat(
const char* fmt,
va_list ap
)noexcept[¶]

Replaces the current of the string by a formatted string fmt (va_list version).

Error String::append(
const char* str,
size_t size = SIZE_MAX
)noexcept[1/3][¶]

Appends str having the given size size to the string.

Null terminated strings can set size to SIZE_MAX.

Error String::append(
const String& other
)noexcept[2/3][¶]

Appends other string to this string.

Error String::append(
char c
)noexcept[3/3][¶]

Appends a single c character.

Error String::appendChars(
char c,
size_t n
)noexcept[¶]

Appends c character repeated n times.

Error String::appendInt(
int64_t i,
uint32_t base = 0,
size_t width = 0,
StringFormatFlags flags = StringFormatFlags::kNone
)noexcept[¶]

Appends a formatted integer i (signed).

Error String::appendUInt(
uint64_t i,
uint32_t base = 0,
size_t width = 0,
StringFormatFlags flags = StringFormatFlags::kNone
)noexcept[¶]

Appends a formatted integer i (unsigned).

Error String::appendHex(
const void* data,
size_t size,
char separator = '\0'
)noexcept[¶]

Appends the given data converted to a HEX string.

template<typename... Args>
Error String::appendFormat(
const char* fmt,
Args&&... args
)noexcept[¶]

Appends a formatted string fmt with args.

Error String::appendVFormat(
const char* fmt,
va_list ap
)noexcept[¶]

Appends a formatted string fmt (va_list version).

Error String::truncate(
size_t newSize
)noexcept[¶]

Truncate the string length into newSize.

void String::_resetInternal()noexcept[¶]

Resets string to embedded and makes it empty (zero length, zero first char)

Note: This is always called internally after an external buffer was released as it zeroes all bytes used by String's embedded storage.

Public Types

Member Functions

class String::ModifyOp : uint32_tenumstrong[¶]

String::String()noexcept[1/2][¶]

String::String(String&& other)noexcept[2/2][¶]

Error String::reset()noexcept[¶]

bool String::empty() constnoexcept[¶]

size_t String::size() constnoexcept[¶]

size_t String::capacity() constnoexcept[¶]

char* String::data()noexcept[1/2][¶]

const char* String::data() constnoexcept[2/2][¶]

void String::swap(String& other)noexcept[¶]

Error String::clear()noexcept[¶]

Error String::assign(const char* data, size_t size = SIZE_MAX)noexcept[1/3][¶]

Error String::assign(const String& other)noexcept[2/3][¶]

Error String::assign(char c)noexcept[3/3][¶]

Error String::assignChars(char c, size_t n)noexcept[¶]

Error String::assignInt(int64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone)noexcept[¶]

Error String::assignUInt(uint64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone)noexcept[¶]

Error String::assignHex(const void* data, size_t size, char separator = '\0')noexcept[¶]

template<typename... Args>Error String::assignFormat(const char* fmt, Args&&... args)noexcept[¶]

Error String::assignVFormat(const char* fmt, va_list ap)noexcept[¶]

Error String::append(const char* str, size_t size = SIZE_MAX)noexcept[1/3][¶]

Error String::append(const String& other)noexcept[2/3][¶]

Error String::append(char c)noexcept[3/3][¶]

Error String::appendChars(char c, size_t n)noexcept[¶]

Error String::appendInt(int64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone)noexcept[¶]

Error String::appendUInt(uint64_t i, uint32_t base = 0, size_t width = 0, StringFormatFlags flags = StringFormatFlags::kNone)noexcept[¶]

Error String::appendHex(const void* data, size_t size, char separator = '\0')noexcept[¶]

template<typename... Args>Error String::appendFormat(const char* fmt, Args&&... args)noexcept[¶]

Error String::appendVFormat(const char* fmt, va_list ap)noexcept[¶]

Error String::truncate(size_t newSize)noexcept[¶]