Memory-managed wrapper type.

Construct a String struct initialized to zero.

Adds a string onto the end of a String, expanding it if necessary.

Adds a byte onto the end of a String, expanding it if necessary.

Appends len bytes of val to string.

If len is positive, val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to ensure that val has at least len addressable bytes.

If len is negative, val must be nul-terminated and len is considered to request the entire string length. This makes stringAppendLen equivalent to stringAppend.

Converts a Unicode character into UTF-8, and appends it to the string.

Appends unescaped to string, escaping any characters that are reserved in URIs using URI-style escape sequences.

Since: 2.16

Converts all uppercase ASCII letters to lowercase ASCII letters.

Converts all lowercase ASCII letters to uppercase ASCII letters.

Copies the bytes from a string into a String, destroying any previous contents. It is rather like the standard strcpy() function, except that you do not have to worry about having enough space to copy the string.

Converts a String to lowercase.

Compares two strings for equality, returning True if they are equal. For use with HashTable.

Removes len bytes from a String, starting at position pos. The rest of the String is shifted down to fill the gap.

Frees the memory allocated for the String. If freeSegment is True it also frees the character data. If it's False, the caller gains ownership of the buffer and must free it after use with free.

Instead of passing False to this function, consider using stringFreeAndSteal.

Frees the memory allocated for the String.

The caller gains ownership of the buffer and must free it after use with free.

Since: 2.76

Transfers ownership of the contents of string to a newly allocated Bytes. The String structure itself is deallocated, and it is therefore invalid to use string after invoking this function.

Note that while String ensures that its buffer always has a trailing nul character (not reflected in its "len"), the returned Bytes does not include this extra nul; i.e. it has length exactly equal to the "len" member.

Since: 2.34

Creates a hash code for str; for use with HashTable.

Inserts a copy of a string into a String, expanding it if necessary.

Inserts a byte into a String, expanding it if necessary.

Inserts len bytes of val into string at pos.

If len is positive, val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to ensure that val has at least len addressable bytes.

If len is negative, val must be nul-terminated and len is considered to request the entire string length.

If pos is -1, bytes are inserted at the end of the string.

Converts a Unicode character into UTF-8, and insert it into the string at the given position.

Creates a new String, initialized with the given string.

Creates a new String with len bytes of the init buffer. Because a length is provided, init need not be nul-terminated, and can contain embedded nul bytes.

Since this function does not stop at nul bytes, it is the caller's responsibility to ensure that init has at least len addressable bytes.

Creates a new String, initialized with the given string.

After this call, init belongs to the String and may no longer be modified by the caller. The memory of data has to be dynamically allocated and will eventually be freed with free.

Since: 2.78

Overwrites part of a string, lengthening it if necessary.

Since: 2.14

Overwrites part of a string, lengthening it if necessary. This function will work with embedded nuls.

Since: 2.14

Adds a string on to the start of a String, expanding it if necessary.

Adds a byte onto the start of a String, expanding it if necessary.

Prepends len bytes of val to string.

If len is positive, val may contain embedded nuls and need not be nul-terminated. It is the caller's responsibility to ensure that val has at least len addressable bytes.

If len is negative, val must be nul-terminated and len is considered to request the entire string length. This makes stringPrependLen equivalent to stringPrepend.

Converts a Unicode character into UTF-8, and prepends it to the string.

Replaces the string find with the string replace in a String up to limit times. If the number of instances of find in the String is less than limit, all instances are replaced. If limit is 0, all instances of find are replaced.

If find is the empty string, since versions 2.69.1 and 2.68.4 the replacement will be inserted no more than once per possible position (beginning of string, end of string and between characters). This did not work correctly in earlier versions.

Since: 2.68

Sets the length of a String. If the length is less than the current length, the string will be truncated. If the length is greater than the current length, the contents of the newly added area are undefined. (However, as always, string->str[string->len] will be a nul byte.)

Creates a new String, with enough space for dflSize bytes. This is useful if you are going to add a lot of text to the string and don't want it to be reallocated too often.

Cuts off the end of the GString, leaving the first len bytes.

Converts a String to uppercase.

Get the value of the “allocated_len” field. When overloading is enabled, this is equivalent to

get string #allocatedLen 

Set the value of the “allocated_len” field. When overloading is enabled, this is equivalent to

set string [ #allocatedLen := value ] 

Get the value of the “len” field. When overloading is enabled, this is equivalent to

get string #len 

Set the value of the “len” field. When overloading is enabled, this is equivalent to

set string [ #len := value ] 

Set the value of the “str” field to Nothing. When overloading is enabled, this is equivalent to

clear #str 

Get the value of the “str” field. When overloading is enabled, this is equivalent to

get string #str 

Set the value of the “str” field. When overloading is enabled, this is equivalent to

set string [ #str := value ]