reid-llvm/documentation/standard_library.md

Standard Library

Strings

pub struct String

Editable string value that can be printed and extended

Has the following binops defined:

• String + *char = String
• String + u64 = String

String::new() -> String

Returns a new empty String-object, which must later be manually freed.

String::from(str: *char) -> String

Creates a new String-object containing initially data from the given string-literal which must be later freed.

String::set(&mut self, c: char, position: u64)

Edits given string by setting the character at index position to be c.

String::push_num(&mut self, num: u64)

Formats the given number into the end of the string.

String::concat(&mut self, source: String)

Concatenates source to the end of destination.

Deprecated functions

pub fn new_string() -> String

Returns a new empty String-object, which must later be manually freed.

deprecated: Use String::new()

pub fn from_str(string: *char) -> String

Creates a new String-object containing initially data from the given string-literal which must be later freed.

deprecated: Use String::from()

pub fn set_char(string: &mut String, c: char, position: u64)

Edits given string by setting the character at index position to be c.

deprecated: Use String::set()

pub fn add_num_to_string(string: &mut String, num: u64)

Formats the given number into the end of the string.

deprecated: Use String::push_num()

pub fn concat_strings(destination: &mut String, source: String)

Concatenates source to the end of destination.

deprecated: Use String::concat()

General

pub fn allocate(size: u64) -> *u8

Unsafely allocates size bytes of memory from the stack, and returns a pointer to it, which must be manually freed.

Maths

pub fn clamp(min: f32, max: f32, value: f32) -> f32

Returns value as clamped between min and max. Equivalent to max(min(value, max), min)

pub fn abs(value: f32) -> f32

Returns the absolute value of value.