Rebase.Data.Text.Foreign

Marshal a Text into a C string with a trailing NUL byte, encoded as UTF-8 in temporary storage.

The Text itself must not contain any NUL bytes, this precondition is not checked. Cf. withCStringLen.

The temporary storage is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this function returns.

O(n) Make a mutable copy of a Text.

O(1) Return the length of a Text in units of Word8. This is useful for sizing a target array appropriately before using unsafeCopyToPtr.

A type representing a number of UTF-8 code units.

O(1) Return the suffix of the Text, with n Word8 units dropped from its beginning.

If n would cause the Text to begin inside a code point, the beginning of the suffix will be advanced by several additional Word8 unit to maintain its validity.

O(n) Create a new Text from a Ptr Word8 by copying the contents of the array.

O(n) Create a new Text from a Ptr Word8 by copying the contents of the NUL-terminated array.

O(n) Decode a null-terminated C string, which is assumed to have been encoded as UTF-8. If decoding fails, a UnicodeException is thrown.

O(n) Decode a C string with explicit length, which is assumed to have been encoded as UTF-8. If decoding fails, a UnicodeException is thrown.

O(1) Return the prefix of the Text of n Word8 units in length.

If n would cause the Text to end inside a code point, the end of the prefix will be advanced by several additional Word8 units to maintain its validity.

O(n) Copy a Text to an array. The array is assumed to be big enough to hold the contents of the entire Text.

O(n) Perform an action on a temporary, mutable copy of a Text. The copy is freed as soon as the action returns.

Marshal a Text into a C string encoded as UTF-8 in temporary storage, with explicit length information. The encoded string may contain NUL bytes, and is not followed by a trailing NUL byte.

The temporary storage is freed when the subcomputation terminates (either normally or via an exception), so the pointer to the temporary storage must not be used after this function returns.