strings #

Description:

strings provides utilities for efficiently processing large strings.

If you got here looking for methods available on the string struct, those methods are found in the builtin module.

fn dice_coefficient(s1 string, s2 string) f32

implementation of Sørensen–Dice coefficient.
find the similarity between two strings.
returns coefficient between 0.0 (not similar) and 1.0 (exact match).

fn find_between_pair_rune(input string, start rune, end rune) string

find_between_pair_rune returns the string found between the pair of marks defined by start and end.
As opposed to the find_between, all_after*, all_before* methods defined on the string type, this function can extract content between nested marks in input.
If start and end marks are nested in input, the characters between the outermost mark pair is returned. It is expected that start and end marks are balanced, meaning that the amount of start marks equal the amount of end marks in the input. An empty string is returned otherwise.
Using two identical marks as start and end results in undefined output behavior.
find_between_pair_rune is inbetween the fastest and slowest in the find_between_pair_* family of functions.

assert strings.find_between_pair_rune('(V) (NOT V)',`(`,`)`) == 'V'

assert strings.find_between_pair_rune('s {X{Y}} s',`{`,`}`) == 'X{Y}'

fn find_between_pair_string(input string, start string, end string) string

find_between_pair_string returns the string found between the pair of marks defined by start and end.
As opposed to the find_between, all_after*, all_before* methods defined on the string type, this function can extract content between nested marks in input.
If start and end marks are nested in input, the characters between the outermost mark pair is returned. It is expected that start and end marks are balanced, meaning that the amount of start marks equal the amount of end marks in the input. An empty string is returned otherwise.
Using two identical marks as start and end results in undefined output behavior.
find_between_pair_string is the slowest in the find_between_pair_* function family.

assert strings.find_between_pair_string('/*V*/ /*NOT V*/','/*','*/') == 'V'

assert strings.find_between_pair_string('s {{X{{Y}}}} s','{{','}}') == 'X{{Y}}'

fn find_between_pair_u8(input string, start u8, end u8) string

find_between_pair_byte returns the string found between the pair of marks defined by start and end.
As opposed to the find_between, all_after*, all_before* methods defined on the string type, this function can extract content between nested marks in input.
If start and end marks are nested in input, the characters between the outermost mark pair is returned. It is expected that start and end marks are balanced, meaning that the amount of start marks equal the amount of end marks in the input. An empty string is returned otherwise.
Using two identical marks as start and end results in undefined output behavior.
find_between_pair_byte is the fastest in the find_between_pair_* family of functions.

assert strings.find_between_pair_u8('(V) (NOT V)',`(`,`)`) == 'V'

assert strings.find_between_pair_u8('s {X{Y}} s',`{`,`}`) == 'X{Y}'

fn levenshtein_distance(a string, b string) int

#-js use levenshtein distance algorithm to calculate the distance between between two strings (lower is closer)

fn levenshtein_distance_percentage(a string, b string) f32

use levenshtein distance algorithm to calculate how similar two strings are as a percentage (higher is closer)

fn new_builder(initial_size int) Builder

new_builder returns a new string builder, with an initial capacity of initial_size

fn repeat(c u8, n int) string

strings.repeat - fill a string with n repetitions of the character c

fn repeat_string(s string, n int) string

strings.repeat_string - gives you n repetitions of the substring s Note: strings.repeat, that repeats a single byte, is between 2x and 24x faster than strings.repeat_string called for a 1 char string.

fn split_capital(s string) []string

split_capital returns an array containing the contents of s split by capital letters.

assert strings.split_capital('XYZ') == ['X', 'Y', 'Z']

assert strings.split_capital('XYStar') == ['X', 'Y', 'Star']

type Builder = []u8

strings.Builder is used to efficiently append many strings to a large dynamically growing buffer, then use the resulting large string. Using a string builder is much better for performance/memory usage than doing constantly string concatenation.

fn (mut b Builder) reuse_as_plain_u8_array() []u8

reuse_as_plain_u8_array allows using the Builder instance as a plain []u8 return value.
It is useful, when you have accumulated data in the builder, that you want to pass/access as []u8 later, without copying or freeing the buffer.
NB: you should NOT use the string builder instance after calling this method.
Use only the return value after calling this method.

fn (mut b Builder) write_ptr(ptr &u8, len int)

write_ptr writes len bytes provided byteptr to the accumulated buffer

fn (mut b Builder) write_rune(r rune)

write_rune appends a single rune to the accumulated buffer

fn (mut b Builder) write_runes(runes []rune)

write_runes appends all the given runes to the accumulated buffer

fn (mut b Builder) clear()

clear clears the buffer contents

fn (mut b Builder) write_u8(data u8)

write_u8 appends a single data byte to the accumulated buffer

fn (mut b Builder) write_byte(data byte)

write_byte appends a single data byte to the accumulated buffer

fn (mut b Builder) write(data []u8) ?int

write implements the Writer interface

fn (mut b Builder) drain_builder(mut other Builder, other_new_cap int)

drain_builder writes all of the other builder content, then re-initialises other, so that the other strings builder is ready to receive new content.

fn (b &Builder) byte_at(n int) u8

byte_at returns a byte, located at a given index i.
Note: it can panic, if there are not enough bytes in the strings builder yet.

fn (mut b Builder) write_string(s string)

write appends the string s to the buffer

fn (mut b Builder) go_back(n int)

go_back discards the last n bytes from the buffer

fn (mut b Builder) cut_last(n int) string

cut_last cuts the last n bytes from the buffer and returns them

fn (mut b Builder) cut_to(pos int) string

cut_to cuts the string after pos and returns it.
if pos is superior to builder length, returns an empty string and cancel further operations

fn (mut b Builder) go_back_to(pos int)

go_back_to resets the buffer to the given position pos Note: pos should be < than the existing buffer length.

fn (mut b Builder) writeln(s string)

writeln appends the string s, and then a newline character.

fn (b &Builder) last_n(n int) string

last_n(5) returns 'world' buf == 'hello world'

fn (b &Builder) after(n int) string

after(6) returns 'world' buf == 'hello world'

fn (mut b Builder) str() string

str returns a copy of all of the accumulated buffer content.
Note: after a call to b.str(), the builder b will be empty, and could be used again.
The returned string owns its own separate copy of the accumulated data that was in the string builder, before the .str() call.

fn (mut b Builder) ensure_cap(n int)

ensure_cap ensures that the buffer has enough space for at least n bytes by growing the buffer if necessary

fn (mut b Builder) free()

free frees the memory block, used for the buffer.
Note: do not use the builder, after a call to free().