57 lines
1.4 KiB
Markdown
57 lines
1.4 KiB
Markdown
## Intrinsics
|
|
|
|
Intrinsics are functions that are defined within the language compiler but not
|
|
in standard library, thus they do not require importing in order to use (and
|
|
trying to re-define these will end up causing issues). Intrinsics include all
|
|
pre-existing binary-operators, but also some regular functions and associated
|
|
functions (that every type has by-default). This document lists them all (except
|
|
for the binary operators, because there are hundreds of those).
|
|
|
|
### Global Intrinsics
|
|
|
|
#### `malloc(size: u64) -> *u8`
|
|
|
|
Allocates `size` bytes and returns a pointer of `u8` of length `size`.
|
|
|
|
```rust
|
|
i32::malloc(40); // Reserves 40 bytes
|
|
```
|
|
|
|
### Macro Intrinsics
|
|
|
|
#### `include_bytes!(path: *char) -> &[u8; _]`
|
|
|
|
Attempts to load file from `path` (relative to module) into memory and includes
|
|
it into the compiled binary directly. Returns a borrow to an array containing
|
|
bytes from the file. Array length varies depending on the file contents.
|
|
|
|
### Associated Intrinsics
|
|
|
|
#### `<T>::sizeof() -> u64`
|
|
|
|
Simply returns the size of type `T` in bytes.
|
|
|
|
```rust
|
|
i32::sizeof(); // Returns 4
|
|
```
|
|
|
|
#### `<T>::null() -> *T`
|
|
|
|
Returns a null-pointer of type `T`.
|
|
|
|
```rust
|
|
i32::null(); // Returns *i32 (null-ptr)
|
|
```
|
|
|
|
#### `<T>::malloc(size: u64) -> *T`
|
|
|
|
Allocates `T::sizeof() * size` bytes and returns a pointer to `T`.
|
|
|
|
**Note:** This does not seem to work correctly currently.
|
|
|
|
```rust
|
|
i32::malloc(30); // Returns *i32
|
|
|
|
// Equivalent to
|
|
malloc(i32::sizeof() * 30) as *i32
|
|
``` |