Module string/index

string/index

String and Unicode types.

Types

rune newtype
rune

Fields

NameTypeDescription
charu32
Methods
from_u32 : (rune) fn(value : u32) -> Option(rune)

Parameters

NameTypeNotes
valueu32

Returns: Option(rune)

to_u32 : (rune) fn(self : rune) -> u32

Parameters

NameTypeNotes
selfrune

Returns: u32

is_ascii : (rune) fn(self : rune) -> bool

Parameters

NameTypeNotes
selfrune

Returns: bool

is_whitespace : (rune) fn(self : rune) -> bool

Parameters

NameTypeNotes
selfrune

Returns: bool

is_digit : (rune) fn(self : rune) -> bool

Parameters

NameTypeNotes
selfrune

Returns: bool

is_alphabetic : (rune) fn(self : rune) -> bool

Parameters

NameTypeNotes
selfrune

Returns: bool

is_uppercase : (rune) fn(self : rune) -> bool

Parameters

NameTypeNotes
selfrune

Returns: bool

is_lowercase : (rune) fn(self : rune) -> bool

Parameters

NameTypeNotes
selfrune

Returns: bool

to_lowercase : (rune) fn(self : rune) -> rune

Parameters

NameTypeNotes
selfrune

Returns: rune

to_uppercase : (rune) fn(self : rune) -> rune

Parameters

NameTypeNotes
selfrune

Returns: rune

String newtype
String

Fields

NameTypeDescription
_bytesOption(ArrayList(u8))
Methods
new : (String) fn() -> String

Returns: String

with_capacity : (String) fn(capacity : usize) -> String

Parameters

NameTypeNotes
capacityusize

Returns: String

from_bytes : (String) fn(bytes : ArrayList(u8)) -> String

Parameters

NameTypeNotes
bytesArrayList(u8)

Returns: String

from : (String) fn(slice : str) -> String

Parameters

NameTypeNotes
slicestr

Returns: String

from_cstr : (String) fn(cstr : *(u8)) -> Result(String, StringError)

Parameters

NameTypeNotes
cstr*(u8)

Returns: Result(String, StringError)

to_cstr : (String) fn(self : String) -> ArrayList(u8)

Parameters

NameTypeNotes
selfString

Returns: ArrayList(u8)

len : (String) fn(self : String) -> usize

Parameters

NameTypeNotes
selfString

Returns: usize

is_empty : (String) fn(self : String) -> bool

Parameters

NameTypeNotes
selfString

Returns: bool

as_bytes : (String) fn(self : String) -> ArrayList(u8)

Parameters

NameTypeNotes
selfString

Returns: ArrayList(u8)

as_str : (String) fn(self : String) -> str

Parameters

NameTypeNotes
selfString

Returns: str

_decode_rune_at : (String) fn(self : String, byte_index : usize) -> Option(rune)

Parameters

NameTypeNotes
selfString
byte_indexusize

Returns: Option(rune)

at : (String) fn(self : String, index : usize) -> Option(rune)

Parameters

NameTypeNotes
selfString
indexusize

Returns: Option(rune)

concat : (String) fn(self : String, other : String) -> String

Parameters

NameTypeNotes
selfString
otherString

Returns: String

push_string : (String) fn(self : String, other : String) -> unit

Parameters

NameTypeNotes
selfString
otherString

Returns: unit

push_str : (String) fn(self : String, s : str) -> unit

Parameters

NameTypeNotes
selfString
sstr

Returns: unit

push_byte : (String) fn(self : String, b : u8) -> unit

Parameters

NameTypeNotes
selfString
bu8

Returns: unit

reserve : (String) fn(self : String, additional : usize) -> unit

Parameters

NameTypeNotes
selfString
additionalusize

Returns: unit

clear : (String) fn(self : String) -> unit

Parameters

NameTypeNotes
selfString

Returns: unit

bytes_len : (String) fn(self : String) -> usize

Parameters

NameTypeNotes
selfString

Returns: usize

substring : (String) fn(self : String, start : usize, end : usize) -> String

Parameters

NameTypeNotes
selfString
startusize
endusize

Returns: String

index_of : (String) fn(self : String, substr : String, (from_index : usize) ?= 0) -> Option(usize)

Parameters

NameTypeNotes
selfString
substrString
from_indexusizedefault: [object Object]

Returns: Option(usize)

contains : (String) fn(self : String, substr : String, (from_index : usize) ?= 0) -> bool

Parameters

NameTypeNotes
selfString
substrString
from_indexusizedefault: [object Object]

Returns: bool

split : (String) fn(self : String, separator : String) -> ArrayList(String)

Parameters

NameTypeNotes
selfString
separatorString

Returns: ArrayList(String)

last_index_of : (String) fn(self : String, substr : String, (from_index : usize) ?= (usize.MAX)) -> Option(usize)

Parameters

NameTypeNotes
selfString
substrString
from_indexusizedefault: [object Object]

Returns: Option(usize)

starts_with : (String) fn(self : String, prefix : String, (position : usize) ?= 0) -> bool

Parameters

NameTypeNotes
selfString
prefixString
positionusizedefault: [object Object]

Returns: bool

ends_with : (String) fn(self : String, suffix : String, (end_position : usize) ?= (usize.MAX)) -> bool

Parameters

NameTypeNotes
selfString
suffixString
end_positionusizedefault: [object Object]

Returns: bool

replace : (String) fn(self : String, search_value : String, new_value : String) -> String

Parameters

NameTypeNotes
selfString
search_valueString
new_valueString

Returns: String

replace_all : (String) fn(self : String, search_value : String, new_value : String) -> String

Parameters

NameTypeNotes
selfString
search_valueString
new_valueString

Returns: String

to_uppercase : (String) fn(self : String) -> String

Parameters

NameTypeNotes
selfString

Returns: String

to_lowercase : (String) fn(self : String) -> String

Parameters

NameTypeNotes
selfString

Returns: String

_is_whitespace_byte : (String) fn(byte : u8) -> bool

Parameters

NameTypeNotes
byteu8

Returns: bool

trim : (String) fn(self : String) -> String

Parameters

NameTypeNotes
selfString

Returns: String

trim_start : (String) fn(self : String) -> String

Parameters

NameTypeNotes
selfString

Returns: String

trim_end : (String) fn(self : String) -> String

Parameters

NameTypeNotes
selfString

Returns: String

chars : (String) fn(self : String) -> StringChars

Parameters

NameTypeNotes
selfString

Returns: StringChars

bytes : (String) fn(self : String) -> StringBytes

Parameters

NameTypeNotes
selfString

Returns: StringBytes

iter : (String) fn(self : String) -> _StringPosIter

Parameters

NameTypeNotes
selfString

Returns: _StringPosIter

into_iter : (String) fn(self : String) -> StringChars

Parameters

NameTypeNotes
selfString

Returns: StringChars

lines : (String) fn(self : String) -> StringLines

Parameters

NameTypeNotes
selfString

Returns: StringLines

repeat : (String) fn(self : String, n : usize) -> String

Parameters

NameTypeNotes
selfString
nusize

Returns: String

join : (String) fn(self : String, items : ArrayList(String)) -> String

Parameters

NameTypeNotes
selfString
itemsArrayList(String)

Returns: String

_is_digit_byte : (String) fn(byte : u8) -> bool

Parameters

NameTypeNotes
byteu8

Returns: bool

parse_i32 : (String) fn(self : String) -> Option(i32)

Parameters

NameTypeNotes
selfString

Returns: Option(i32)

parse_i64 : (String) fn(self : String) -> Option(i64)

Parameters

NameTypeNotes
selfString

Returns: Option(i64)

parse_u32 : (String) fn(self : String) -> Option(u32)

Parameters

NameTypeNotes
selfString

Returns: Option(u32)

parse_u64 : (String) fn(self : String) -> Option(u64)

Parameters

NameTypeNotes
selfString

Returns: Option(u64)

parse_bool : (String) fn(self : String) -> Option(bool)

Parameters

NameTypeNotes
selfString

Returns: Option(bool)

StringError

Variants

VariantFieldsDescription
InvalidUtf8
IndexOutOfBoundsindex: usize, length: usize
StringChars struct
StringChars

Fields

NameTypeDescription
_stringString
_byte_indexusize
impl(forall(I : Type), where(I <: Iterator), I)
into_iter : fn(self : I) -> I

Parameters

NameTypeNotes
selfI

Returns: I

impl(forall(I : Type), where(I <: Iterator), I)
map : fn(forall(comptime(A) : Type, comptime(B) : Type, comptime(F) : Type), self : I, f : F) -> IterMap(I, B, F)

Parameters

NameTypeNotes
selfI
fF

Returns: IterMap(I, B, F)

filter : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, f : F) -> IterFilter(I, F)

Parameters

NameTypeNotes
selfI
fF

Returns: IterFilter(I, F)

take : fn(forall(comptime(A) : Type), self : I, n : usize) -> IterTake(I)

Parameters

NameTypeNotes
selfI
nusize

Returns: IterTake(I)

skip : fn(forall(comptime(A) : Type), self : I, n : usize) -> IterSkip(I)

Parameters

NameTypeNotes
selfI
nusize

Returns: IterSkip(I)

enumerate : fn(forall(comptime(A) : Type), self : I) -> IterEnumerate(I)

Parameters

NameTypeNotes
selfI

Returns: IterEnumerate(I)

zip : fn(forall(comptime(A) : Type, comptime(J) : Type, comptime(B) : Type), self : I, other : J) -> IterZip(I, J)

Parameters

NameTypeNotes
selfI
otherJ

Returns: IterZip(I, J)

fold : fn(forall(comptime(A) : Type, comptime(Acc) : Type, comptime(F) : Type), self : I, init : Acc, f : F) -> Acc

Parameters

NameTypeNotes
selfI
initAcc
fF

Returns: Acc

for_each : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, f : F) -> unit

Parameters

NameTypeNotes
selfI
fF

Returns: unit

count : fn(forall(comptime(A) : Type), self : I) -> usize

Parameters

NameTypeNotes
selfI

Returns: usize

any : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, pred : F) -> bool

Parameters

NameTypeNotes
selfI
predF

Returns: bool

all : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, pred : F) -> bool

Parameters

NameTypeNotes
selfI
predF

Returns: bool

StringBytes struct
StringBytes

Fields

NameTypeDescription
_stringString
_indexusize
impl(forall(I : Type), where(I <: Iterator), I)
into_iter : fn(self : I) -> I

Parameters

NameTypeNotes
selfI

Returns: I

impl(forall(I : Type), where(I <: Iterator), I)
map : fn(forall(comptime(A) : Type, comptime(B) : Type, comptime(F) : Type), self : I, f : F) -> IterMap(I, B, F)

Parameters

NameTypeNotes
selfI
fF

Returns: IterMap(I, B, F)

filter : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, f : F) -> IterFilter(I, F)

Parameters

NameTypeNotes
selfI
fF

Returns: IterFilter(I, F)

take : fn(forall(comptime(A) : Type), self : I, n : usize) -> IterTake(I)

Parameters

NameTypeNotes
selfI
nusize

Returns: IterTake(I)

skip : fn(forall(comptime(A) : Type), self : I, n : usize) -> IterSkip(I)

Parameters

NameTypeNotes
selfI
nusize

Returns: IterSkip(I)

enumerate : fn(forall(comptime(A) : Type), self : I) -> IterEnumerate(I)

Parameters

NameTypeNotes
selfI

Returns: IterEnumerate(I)

zip : fn(forall(comptime(A) : Type, comptime(J) : Type, comptime(B) : Type), self : I, other : J) -> IterZip(I, J)

Parameters

NameTypeNotes
selfI
otherJ

Returns: IterZip(I, J)

fold : fn(forall(comptime(A) : Type, comptime(Acc) : Type, comptime(F) : Type), self : I, init : Acc, f : F) -> Acc

Parameters

NameTypeNotes
selfI
initAcc
fF

Returns: Acc

for_each : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, f : F) -> unit

Parameters

NameTypeNotes
selfI
fF

Returns: unit

count : fn(forall(comptime(A) : Type), self : I) -> usize

Parameters

NameTypeNotes
selfI

Returns: usize

any : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, pred : F) -> bool

Parameters

NameTypeNotes
selfI
predF

Returns: bool

all : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, pred : F) -> bool

Parameters

NameTypeNotes
selfI
predF

Returns: bool

StringLines struct
StringLines

Fields

NameTypeDescription
_stringString
_byte_indexusize
impl(forall(I : Type), where(I <: Iterator), I)
into_iter : fn(self : I) -> I

Parameters

NameTypeNotes
selfI

Returns: I

impl(forall(I : Type), where(I <: Iterator), I)
map : fn(forall(comptime(A) : Type, comptime(B) : Type, comptime(F) : Type), self : I, f : F) -> IterMap(I, B, F)

Parameters

NameTypeNotes
selfI
fF

Returns: IterMap(I, B, F)

filter : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, f : F) -> IterFilter(I, F)

Parameters

NameTypeNotes
selfI
fF

Returns: IterFilter(I, F)

take : fn(forall(comptime(A) : Type), self : I, n : usize) -> IterTake(I)

Parameters

NameTypeNotes
selfI
nusize

Returns: IterTake(I)

skip : fn(forall(comptime(A) : Type), self : I, n : usize) -> IterSkip(I)

Parameters

NameTypeNotes
selfI
nusize

Returns: IterSkip(I)

enumerate : fn(forall(comptime(A) : Type), self : I) -> IterEnumerate(I)

Parameters

NameTypeNotes
selfI

Returns: IterEnumerate(I)

zip : fn(forall(comptime(A) : Type, comptime(J) : Type, comptime(B) : Type), self : I, other : J) -> IterZip(I, J)

Parameters

NameTypeNotes
selfI
otherJ

Returns: IterZip(I, J)

fold : fn(forall(comptime(A) : Type, comptime(Acc) : Type, comptime(F) : Type), self : I, init : Acc, f : F) -> Acc

Parameters

NameTypeNotes
selfI
initAcc
fF

Returns: Acc

for_each : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, f : F) -> unit

Parameters

NameTypeNotes
selfI
fF

Returns: unit

count : fn(forall(comptime(A) : Type), self : I) -> usize

Parameters

NameTypeNotes
selfI

Returns: usize

any : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, pred : F) -> bool

Parameters

NameTypeNotes
selfI
predF

Returns: bool

all : fn(forall(comptime(A) : Type, comptime(F) : Type), self : I, pred : F) -> bool

Parameters

NameTypeNotes
selfI
predF

Returns: bool

StringBuilder object
StringBuilder

Fields

NameTypeDescription
_bufArrayList(u8)
Methods
new : (StringBuilder) fn() -> StringBuilder

Returns: StringBuilder

with_capacity : (StringBuilder) fn(capacity : usize) -> StringBuilder

Parameters

NameTypeNotes
capacityusize

Returns: StringBuilder

len : (StringBuilder) fn(self : StringBuilder) -> usize

Parameters

NameTypeNotes
selfStringBuilder

Returns: usize

is_empty : (StringBuilder) fn(self : StringBuilder) -> bool

Parameters

NameTypeNotes
selfStringBuilder

Returns: bool

write_str : (StringBuilder) fn(self : StringBuilder, s : str) -> unit

Parameters

NameTypeNotes
selfStringBuilder
sstr

Returns: unit

write_string : (StringBuilder) fn(self : StringBuilder, s : String) -> unit

Parameters

NameTypeNotes
selfStringBuilder
sString

Returns: unit

write_byte : (StringBuilder) fn(self : StringBuilder, b : u8) -> unit

Parameters

NameTypeNotes
selfStringBuilder
bu8

Returns: unit

write_rune : (StringBuilder) fn(self : StringBuilder, r : rune) -> unit

Parameters

NameTypeNotes
selfStringBuilder
rrune

Returns: unit

write_line : (StringBuilder) fn(self : StringBuilder, s : String) -> unit

Parameters

NameTypeNotes
selfStringBuilder
sString

Returns: unit

to_string : (StringBuilder) fn(self : StringBuilder) -> String

Parameters

NameTypeNotes
selfStringBuilder

Returns: String

clear : (StringBuilder) fn(self : StringBuilder) -> unit

Parameters

NameTypeNotes
selfStringBuilder

Returns: unit

Functions

assert_dyn function
fn(flag : bool, msg : String) -> unit

Parameters

NameTypeNotes
flagbool
msgString

Returns: unit

panic_dyn function
fn(msg : String) -> unit

Parameters

NameTypeNotes
msgString

Returns: unit