String Rt¶

1

import "std/runtime/string_rt";

String struct¶

Heap-allocated builtin String type to enable dynamic modification in contrast to the primitive string type.

An empty String stays in an unallocated default state: contents is nil and capacity is 0. The heap buffer is only allocated once the first character is stored, keeping default-constructed and empty strings free of heap traffic.

Constructors¶

ctor¶

1

public p String.ctor(const string value = "")

Construct a String from a raw string value

Parameters

ctor¶

1

public p String.ctor(const char value)

Construct a String holding a single character

Parameters

ctor¶

1

public p String.ctor(const String& original)

Construct a String as a deep copy of another String

Parameters

ctor¶

1

public p String.ctor<IntLong>(IntLong initialSize)

Construct a String pre-allocating space for the given number of characters

Parameters

dtor¶

1

public p String.dtor()

Destruct the String, freeing its heap-allocated character buffer

Methods¶

append¶

1

public p String.append(const string appendix)

Appends the given string to the current one

Parameters

append¶

1

public p String.append(const String& appendix)

Appends the given String to the current one

Parameters

append¶

1

public p String.append(const string appendix, unsigned long appendixLength)

Appends the first appendixLength bytes of the given string to the current one.

In contrast to the single-argument overload, the appendix is not required to be null-terminated and may contain embedded null bytes. This makes the overload the right choice for raw payloads that were read from a file, a socket or any other byte source.

Parameters

append¶

1

public p String.append(const char c)

Appends the given char to the string and resize it if needed

Parameters

insert¶

1

public p String.insert<IntLong>(unsigned IntLong position, string str)

Insert a raw string into the string at the given position

Parameters

insert¶

1

public p String.insert<IntLong>(unsigned IntLong position, const String& str)

Insert a String into the string at the given position

Parameters

insert¶

1

public p String.insert<IntLong>(unsigned IntLong position, char c)

Insert a single character into the string at the given position

Parameters

getRaw¶

1

public inline f<string> String.getRaw()

Get the raw and immutable string from this container instance

Returns: string — Raw immutable string

getLength¶

1

public inline f<unsigned long> String.getLength()

Retrieve the current length of the string

Returns: unsigned long — Current length of the string

getCapacity¶

1

public inline f<unsigned long> String.getCapacity()

Retrieve the current capacity of the string

Returns: unsigned long — Current capacity of the string

isEmpty¶

1

public inline f<bool> String.isEmpty()

Check if the string is empty

Returns: bool

isFull¶

1

public inline f<bool> String.isFull()

Checks if the string exhausts its capacity

Returns: bool — Full or not full

clear¶

1

public p String.clear()

Replaces the current contents of the string with an empty string

find¶

1

public f<long> String.find(string needle, unsigned long startIndex = 0l)

Searches for a substring in a string. Returns -1 if the string was not found.

Parameters

Returns: long — Index, where the substring was found / -1

find¶

1

public f<long> String.find(string needle, unsigned int startIndex)

Searches for a substring in a string. Returns -1 if the string was not found.

Parameters

Returns: long — Index, where the substring was found / -1

find¶

1

public f<long> String.find(char needle, unsigned long startIndex = 0l)

Searches for a char in a string. Returns -1 if the char was not found.

Parameters

Returns: long — Index, where the char was found / -1

rfind¶

1

public f<long> String.rfind(string needle, unsigned long startIndex = 0l)

Searches for a substring in a string from the back. Returns -1 if the string was not found.

Parameters

Returns: long — Index, where the substring was found / -1

rfind¶

1

public f<long> String.rfind(string needle, unsigned int startIndex)

Searches for a substring in a string from the back. Returns -1 if the string was not found.

Parameters

Returns: long — Index, where the substring was found / -1

rfind¶

1

public f<long> String.rfind(char needle, unsigned long startIndex = 0l)

Searches for a char in a string from the back. Returns -1 if the char was not found.

Parameters

Returns: long — Index, where the char was found / -1

contains¶

1

public inline f<bool> String.contains(string needle)

Checks if the string contains a substring

Parameters

Returns: bool — Found or not

startsWith¶

1

public f<bool> String.startsWith(string prefix)

Checks if the string starts with a given prefix

Parameters

Returns: bool — Starts with prefix or not

endsWith¶

1

public f<bool> String.endsWith(string suffix)

Checks if the string ends with a given suffix

Parameters

Returns: bool — Ends with suffix or not

reverse¶

1

public p String.reverse()

Reverse the string

replace¶

1

public f<bool> String.replace( string needle, string replacement, unsigned long startIdx = 0l )

Replace occurrence of substring with the replacement string

Parameters

Returns: bool

replaceAll¶

1

public f<unsigned long> String.replaceAll(string needle, string replacement)

Replace all occurrences of substring with the replacement string

Parameters

Returns: unsigned long

replaceAll¶

1

public f<unsigned long> String.replaceAll(char needle, char replacement)

Replaces all occurrences of a character with another character

Parameters

Returns: unsigned long — Number of replacements made

getSubstring¶

1

public f<String> String.getSubstring<IntLongShort>(unsigned IntLongShort startIdx, long length = -1l)

Returns the substring of the current string, starting at position startIndex with the length of length.

Parameters

Returns: String — Substring

trim¶

1

public f<String> String.trim()

Returns a new string without leading or trailing whitespaces.

Returns: String — Trimmed string

reserve¶

1

public p String.reserve<IntLongShort>(unsigned IntLongShort charCount)

Reserves charCount items

Parameters

Functions¶

getRawLength¶

1

public f<unsigned long> getRawLength(string input)

Returns the length of a string

Parameters

Returns: unsigned long — Length of the input string

isRawEqual¶

1

public f<bool> isRawEqual(string lhs, string rhs)

Checks the equality of two raw strings

Parameters

Returns: bool — Equality of lhs and rhs

Operators¶

operator=¶

1

public p operator=(String& this, const String& newValue)

Copy-assign the contents of another String into this one

Parameters

operator+¶

1

public f<String> operator+<StrTy, StrTyChar>(const StrTy& a, const StrTyChar& b)

Concatenates two strings and returns the result

Parameters

Returns: String — Concatenated string

operator+=¶

1

public p operator+=<StrTyChar>(String& a, const StrTyChar& b)

Concatenates b to the end of a

Parameters

operator*¶

1

public f<String> operator*<IntLongShort>(const String& str, const IntLongShort n)

Concatenates the given string with itself n times.

Parameters

Returns: String — Result string

operator*¶

1

public f<String> operator*<IntLongShort>(const IntLongShort n, const String& str)

Concatenates the given string with itself n times

Parameters

Returns: String — Result string

operator*=¶

1

public p operator*=<IntLongShort>(String& str, const IntLongShort n)

Concatenates this string with itself n times

Parameters

operator==¶

1

public f<bool> operator==(const String& a, const String& b)

Checks if two strings have the same value

Parameters

Returns: bool — Equal or not

operator==¶

1

public f<bool> operator==(const String& a, string b)

Checks if a String and a raw string have the same value

Parameters

Returns: bool — Equal or not

operator==¶

1

public f<bool> operator==(string a, const String& b)

Checks if a raw string and a String have the same value

Parameters

Returns: bool — Equal or not

operator!=¶

1

public f<bool> operator!=(const String& a, const String& b)

Checks if two strings have not the same value

Parameters

Returns: bool — Not equal or not

operator!=¶

1

public f<bool> operator!=(const String& a, const string& b)

Checks if a String and a raw string do not have the same value

Parameters

Returns: bool — Not equal or not

operator!=¶

1

public f<bool> operator!=(const string& a, const String& b)

Checks if a raw string and a String do not have the same value

Parameters

Returns: bool — Not equal or not

operator[]¶

1

public f<char&> operator[](String& str, unsigned long idx)

Extract the char at the given index and return it

Parameters

Returns: char& — Character at the given index

operator[]¶

1

public f<char&> operator[](String& str, unsigned int idx)

Extract the char at the given index and return it

Parameters

Returns: char& — Character at the given index