AsmJit
Low-Latency Machine Code Generation
Roadmap
Docs
Parser
Support
GitHub
Index ⭢ Utilities ⭢ asmjit::String

asmjit::String Class Reference [¶]

Inheritance diagram for asmjit::String:
asmjit::StringTmp< N >

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

This string has 3 allocation possibilities:

  1. 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.
  2. 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.
  3. 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

Member Functions

Construction & Destruction
Overloaded Operators
Accessors
String Operations
Error assign_format(const char* fmt, Args&&... args) noexcept
Error append_format(const char* fmt, Args&&... args) noexcept
Internal Functions

String::ModifyOp : uint32_tenum classstrong[¶]

String operation.

ConstantDescription
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::is_empty() constnodiscardnoexcept[¶]

Tests whether the string is empty.

size_t String::size() constnodiscardnoexcept[¶]

Returns the size of the string.

size_t String::capacity() constnodiscardnoexcept[¶]

Returns the capacity of the string.

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

Returns the data of the string.

const char* String::data() constnodiscardnoexcept[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/4][¶]

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

Null terminated strings can set size to SIZE_MAX.

Error String::assign(
Span<const char> span
)noexcept[2/4][¶]

Appends the given span to the string.

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

Replaces the current of the string with other string.

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

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

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

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

Error String::assign_int(
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::assign_uint(
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::assign_hex(
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::assign_format(
const char* fmt,
Args&&... args
)noexcept[¶]

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

Error String::assign_vformat(
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/4][¶]

Appends str having the given size size to the string.

Null terminated strings can set size to SIZE_MAX.

Error String::append(
Span<const char> span
)noexcept[2/4][¶]

Appends the given span to the string.

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

Appends other string to this string.

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

Appends a single c character.

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

Appends c character repeated n times.

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

Appends a formatted integer i (signed).

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

Appends a formatted integer i (unsigned).

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

Appends the given data converted to a HEX string.

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

Appends a formatted string fmt with args.

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

Appends a formatted string fmt (va_list version).

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

Truncate the string length into new_size.

void String::_reset_internal()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.

© 2018-2025 AsmJit Team | GitHub | Chat | Blog

AsmJit and AsmTK libraries are open source software released under the Zlib license and can be used safely in any open-source or commercial product, statically or dynamically linked, and without having to advertise the use of the libraries. Code snippets and examples are released into public domain, see Unlicense for more details.