## std.mem: Unsafe functions for working with raw memory.
## This module is imported by default.

## Raw pointers. Extremely unsafe.
## While they are removed from the memory model by default (and hence can
## cause memory errors), pointers must know what *type* they point at.
## This cuts down on errors somewhat - not much, but somewhat.
@[magic]
pub type ptr[T] =
  addr: uint
## Heap-allocated, memory-safe references.
@[magic]
pub type ref[T]
## Heap-allocated, reference-counted references.
## These are a special type - rather than anything handled by the type system
## alone - because there are significant optimizations the compiler can make.
@[magic]
pub type refc[T]

## Tells the compiler to interpret data of one type directly as data of another.
## Extremely unsafe. Take caution to memory representations when using.
## Compiler magic. The type signature is left here for documentation purposes.
@[unsafe, magic]
pub func cast[T, U](self: T): U

## Sets the sizeof(T) bytes following data + offset * sizeof(T) to T.
## Extremely unsafe.
@[unsafe]
pub func set[T](data: ptr T, val: T, offset: uint = 0) =
  ...

## Gets the value at data + offset * sizeof(T), and interprets it as type T.
## Extremely unsafe.
@[unsafe]
pub func get[T](data: ptr T, offset: uint = 0) =
  ...

## Returns a pointer offset by offset * sizeof(T).
## Extremely unsafe.
@[unsafe]
pub func offset[T](data: ptr T, offset: uint): ptr T =
  ...

@[unsafe]
pub func malloc[T](size: uint = sizeof(T)): ptr T =
  ...

@[unsafe]
pub func calloc[T](size: uint = sizeof(T)): ptr T =
  ...

@[unsafe]
pub func realloc[T](data: ptr T): ptr T =
  ...

@[unsafe]
pub func copy[T](from: ptr T, to: ptr T, length: uint) =
  ...