Basement.String

Opaque packed array of characters in the UTF8 encoding

Mutable String Buffer.

Use as an *append* buffer, as UTF8 variable encoding doesn't really allow to change previously written character without potentially shifting bytes.

Unsafely create a string of up to sz bytes.

The callback f needs to return the number of bytes filled in the underlaying bytes buffer. No check is made on the callback return values, and if it's not contained without the bounds, bad things will happen.

Replicate a character c n times to create a string of length n

Length of a String using CountOf

this size is available in o(n)

Various String Encoding that can be use to convert to and from bytes

Convert a ByteArray to a string assuming a specific encoding.

It returns a 3-tuple of:

• The string that has been succesfully converted without any error

• An optional validation error

• The remaining buffer that hasn't been processed (either as a result of an error, or because the encoded sequence is not fully available)

Considering a stream of data that is fetched chunk by chunk, it's valid to assume that some sequence might fall in a chunk boundary. When converting chunks, if the error is Nothing and the remaining buffer is not empty, then this buffer need to be prepended to the next chunk

Decode a stream of binary chunks containing UTF8 encoding in a list of valid String

Chunk not necessarily contains a valid string, as a UTF8 sequence could be split over 2 chunks.

Convert a Byte Array representing UTF8 data directly to a string without checking for UTF8 validity

If the input contains invalid sequences, it will trigger runtime async errors when processing data.

In doubt, use fromBytes

Convert a UTF8 array of bytes to a String.

If there's any error in the stream, it will automatically insert replacement bytes to replace invalid sequences.

In the case of sequence that fall in the middle of 2 chunks, the remaining buffer is supposed to be preprended to the next chunk, and resume the parsing.

Convert a String to a bytearray in a specific encoding

if the encoding is UTF8, the underlying buffer is returned without extra allocation or any processing

In any other encoding, some allocation and processing are done to convert.

Similar to validate but works on a MutableByteArray

Copy the String

The slice of memory is copied to a new slice, making the new string independent from the original string..

Possible failure related to validating bytes of UTF8 sequences.

Return the nth character in a String

Compared to an array, the string need to be scanned from the beginning since the UTF8 encoding is variable.

Check if a String is null

Create a string with the remaining Chars after dropping @n Chars from the beginning

Create a string composed of a number @n of Chars (Unicode code points).

if the input @s contains less characters than required, then the input string is returned.

Split a string at the Offset specified (in Char) returning both the leading part and the remaining part.

Similar to drop but from the end

Similar to take but from the end

Similar to splitAt but from the end

Split on the input string using the predicate as separator

e.g.

splitOn (== ',') ","          == ["",""]
splitOn (== ',') ",abc,"      == ["","abc",""]
splitOn (== ':') "abc"        == ["abc"]
splitOn (== ':') "abc::def"   == ["abc","","def"]
splitOn (== ':') "::abc::def" == ["","","abc","","def"]

Internal call to make a substring given offset in bytes.

This is unsafe considering that one can create a substring starting and/or ending on the middle of a UTF8 sequence.

Return whereas the string contains a specific character or not

Finds where are the insertion points when we search for a needle within an haystack.

Intersperse the character sep between each character in the string

intersperse ' ' "Hello Foundation"

"H e l l o F o u n d a t i o n"

Apply a predicate to the string to return the longest prefix that satisfy the predicate and the remaining

Apply a predicate to the string to return the longest suffix that satisfy the predicate and the remaining

Break a string into 2 strings at the location where the predicate return True

Break a string into 2 strings at the first occurence of the character

Same as break but cut on a line feed with an optional carriage return.

This is the same operation as 'breakElem LF' dropping the last character of the string if it's a CR.

Also for efficiency reason (streaming), it returns if the last character was a CR character.

Drop character from the beginning while the predicate is true

Create a single element String

Monomorphically map the character in a string and return the transformed one

Append a Char to the end of the String and return this new String

Prepend a Char to the beginning of the String and return this new String

Extract the String stripped of the last character and the last character if not empty

If empty, Nothing is returned

Extract the First character of a string, and the String stripped of the first character.

If empty, Nothing is returned

Look for a predicate in the String and return the matched character, if any.

Return the index in unit of Char of the first occurence of the predicate returning True

If not found, Nothing is returned

Sort the character in a String using a specific sort function

TODO: optimise not going through a list

Filter characters of a string using the predicate

Reverse a string

Replace all the occurrencies of needle with replacement in the haystack string.

Append a character to a String builder

Create a new String builder using chunks of sizeChunksI

Read an Integer from a String

Consume an optional minus sign and many digits until end of string.

Read a Natural from a String

Consume many digits until end of string.

Try to read a Double

Try to read a floating number as a Rational

Note that for safety reason, only exponent between -10000 and 10000 is allowed as otherwise DoS/OOM is very likely. if you don't want this behavior, switching to a scientific type (not provided yet) that represent the exponent separately is the advised solution.

Read an Floating like number of the form:

-

numbers

[

.

numbers

] [ (

e

|

E

) [

-

]

number

]

Call a function with:

• A boolean representing if the number is negative

• The digits part represented as a single natural number (123.456 is represented as 123456)

• The number of digits in the fractional part (e.g. 123.456 => 3)

• The exponent if any

The code is structured as a simple state machine that:

• Optionally Consume a - sign

• Consume number for the integral part

• Optionally

• Consume .

• Consume remaining digits if not already end of string

• Optionally Consume a e or E follow by an optional - and a number

Convert a String to the upper-case equivalent.

Convert a String to the upper-case equivalent.

Convert a String to the unicode case fold equivalent.

Case folding is mostly used for caseless comparison of strings.

Check whether the first string is a prefix of the second string.

Check whether the first string is a suffix of the second string.

Check whether the first string is contains within the second string.

TODO: implemented the naive way and thus terribly inefficient, reimplement properly

Try to strip a prefix from the start of a String.

If the prefix is not starting the string, then Nothing is returned, otherwise the striped string is returned

Try to strip a suffix from the end of a String.

If the suffix is not ending the string, then Nothing is returned, otherwise the striped string is returned

Split lines in a string using newline as separation.

Note that carriage return preceding a newline are also strip for maximum compatibility between Windows and Unix system.

Split words in a string using spaces as separation

words "Hello Foundation"

Hello, Foundation

Transform string src to base64 binary representation.

Transform string src to URL-safe base64 binary representation. The result will be either padded or unpadded, depending on the boolean padded argument.

Transform string src to OpenBSD base64 binary representation.