Ekdohibs
/
zig
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add alignment docs

master
Andrew Kelley 2018-04-22 12:52:28 -04:00
parent a3e9ae8f74
commit 98b88bb52f
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
std/mem.zig
View File

@ -11,6 +11,8 @@ pub const Allocator = struct {
/// Allocate byte_count bytes and return them in a slice, with the /// Allocate byte_count bytes and return them in a slice, with the
/// slice's pointer aligned at least to alignment bytes. /// slice's pointer aligned at least to alignment bytes.
/// The returned newly allocated memory is undefined. /// The returned newly allocated memory is undefined.
/// `alignment` is guaranteed to be >= 1
/// `alignment` is guaranteed to be a power of 2
allocFn: fn (self: &Allocator, byte_count: usize, alignment: u29) Error![]u8, allocFn: fn (self: &Allocator, byte_count: usize, alignment: u29) Error![]u8,
/// If `new_byte_count > old_mem.len`: /// If `new_byte_count > old_mem.len`:
@ -22,6 +24,8 @@ pub const Allocator = struct {
/// * alignment <= alignment of old_mem.ptr /// * alignment <= alignment of old_mem.ptr
/// ///
/// The returned newly allocated memory is undefined. /// The returned newly allocated memory is undefined.
/// `alignment` is guaranteed to be >= 1
/// `alignment` is guaranteed to be a power of 2
reallocFn: fn (self: &Allocator, old_mem: []u8, new_byte_count: usize, alignment: u29) Error![]u8, reallocFn: fn (self: &Allocator, old_mem: []u8, new_byte_count: usize, alignment: u29) Error![]u8,
/// Guaranteed: `old_mem.len` is the same as what was returned from `allocFn` or `reallocFn` /// Guaranteed: `old_mem.len` is the same as what was returned from `allocFn` or `reallocFn`