Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › multi_array_list › MultiArrayList › shrinkAndFree Public Function shrinkAndFree Doc Source Public Function std.multi_array_list.MultiArrayList.shrinkAndFree
pub fn shrinkAndFree (self : *Self , gpa : Allocator , new_len : usize ) void Params File multi_array_list.zig: 458
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495 pub fn shrinkAndFree (self : *Self , gpa : Allocator , new_len : usize ) void {
if (new_len == 0 ) return clearAndFree (self , gpa );
assert (new_len <= self .capacity );
assert (new_len <= self .len );
const other_bytes = gpa .alignedAlloc (u8 , sizes .big_align , capacityInBytes (new_len )) catch {
const self_slice = self .slice ();
inline for (field_types , 0 ..) |field_type , i | {
if (@sizeOf (field_type ) != 0 ) {
const field = @as (Field , @fromBackingInt (@intCast (i )));
const dest_slice = self_slice .items (field )[new_len ..];
// We use memset here for more efficient codegen in safety-checked,
// valgrind-enabled builds. Otherwise the valgrind client request
// will be repeated for every element.
@memset (dest_slice , undefined );
}
}
self .len = new_len ;
return ;
};
var other = Self {
.bytes = other_bytes .ptr ,
.capacity = new_len ,
.len = new_len ,
};
self .len = new_len ;
const self_slice = self .slice ();
const other_slice = other .slice ();
inline for (field_types , 0 ..) |field_type , i | {
if (@sizeOf (field_type ) != 0 ) {
const field = @as (Field , @fromBackingInt (@intCast (i )));
@memcpy (other_slice .items (field ), self_slice .items (field ));
}
}
gpa .free (self .allocatedBytes ());
self .* = other ;
}
Attempt to reduce allocated capacity to
new_len. Ifnew_lenis greater than zero, this may fail to reduce the capacity, but the data remains intact and the length is updated to new_len.