String API

`Str`

Allows storing a collection of multiple characters under a single variable.

obj Str {
  empty: bool
  len: int
  lower: Self
  lowerFirst: Self
  upper: Self
  upperFirst: Self
}

Fields

empty - Whether string has characters.
len - Number of characters.
lower - Representation of string with characters lowercased.
lowerFirst - Representation of string with first character lowercased.
upper - Representation of string with characters uppercased.
upperFirst - Representation of string with first character uppercased.

`Str.contains()`

Checks whether calling string contains search substring.

fn Str.contains (search: Self) bool

Parameters

search - Substring to check if exists.

`Str.find()`

Searches for substring and returns its position, otherwise -1 is returned.

fn Str.find (search: Self) int

Parameters

search - Substring to search for.

`Str.lines()`

Splits string by lines. Delimited by any of: \r, \n, \r\n.

fn Str.lines (keepLineBreaks := false) Self[]

Parameters

keepLineBreaks - Whether resulting array should contain line endings. The default is false.

`Str.replace()`

Returns a copy of calling string with search replaced with replacement.

fn Str.replace (search: Self, replacement: Self, count := 0) Self

Parameters

search - Substring to search for.
replacement - Substring to replace with.
count - Number of times search should be replaced. All occurrences are replaced when count <= 0.

`Str.slice()`

Extracts string slice from start to end (end not included).

fn Str.slice (start := 0, end := self.len) Self

Parameters

start - Index at which to start extraction. The default is zero.

If value is negative then string length is added to it.
If value is less than string length then 0 value is used.
If value is greater than string length then nothing is extracted.

end - Index at which to end extraction. The default is string length.

If value is negative then string length is added to it.
If value is less than string length then 0 value is used.
If value is greater than string length then string length is used.
If value positioned before or equals start then nothing is extracted.

`Str.split()`

Splits string into array of string delimited with delimiter.

fn Str.split (delimiter := "") Self[]

Parameters

delimiter - Delimiter to split with.

`Str.toBuffer()`

Converts a string to buffer_Buffer object.

fn Str.toBuffer () buffer_Buffer

`Str.toFloat()`

Converts a string to float representation.

fn Str.toFloat () float

`Str.toF32()`

Converts a string to f32 representation.

fn Str.toF32 () f32

`Str.toF64()`

Converts a string to f64 representation.

fn Str.toF64 () f64