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 › mem › writePackedIntLittle Private Function writePackedIntLittle Doc Source Private Function std.mem.writePackedIntLittle
fn writePackedIntLittle (comptime T : type , bytes : []u8 , bit_offset : usize , value : T ) void Params T : type bytes : []u8 bit_offset : usize value : T File mem.zig: 2081
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112 fn writePackedIntLittle (comptime T : type , bytes : []u8 , bit_offset : usize , value : T ) void {
const uN = @Int (.unsigned , @bitSizeOf (T ));
const Log2N = std .math .Log2Int (T );
const bit_count = @as (usize , @bitSizeOf (T ));
const bit_shift = @as (u3 , @intCast (bit_offset % 8 ));
const store_size = (@bitSizeOf (T ) + 7 ) / 8 ;
const store_tail_bits = @as (u3 , @intCast ((store_size * 8 ) - bit_count ));
const StoreInt = @Int (.unsigned , store_size * 8 );
if (bit_count == 0 )
return ;
// Write by storing a StoreInt, and then follow it up with a 1-byte tail
// if bit_offset pushed us over a byte boundary.
const write_bytes = bytes [bit_offset / 8 ..];
const head = write_bytes [0 ] & ((@as (u8 , 1 ) << bit_shift ) - 1 );
var write_value = (@as (StoreInt , @as (uN , @bitCast (value ))) << bit_shift ) | @as (StoreInt , @intCast (head ));
if (bit_shift > store_tail_bits ) {
const tail_len = @as (Log2N , @intCast (bit_shift - store_tail_bits ));
write_bytes [store_size ] &= ~((@as (u8 , 1 ) << @as (u3 , @intCast (tail_len ))) - 1 );
write_bytes [store_size ] |= @as (u8 , @intCast ((@as (uN , @bitCast (value )) >> (@as (Log2N , @truncate (bit_count )) -% tail_len ))));
} else if (bit_shift < store_tail_bits ) {
const tail_len = store_tail_bits - bit_shift ;
const tail = write_bytes [store_size - 1 ] & (@as (u8 , 0xfe ) << (7 - tail_len ));
write_value |= @as (StoreInt , tail ) << (8 * (store_size - 1 ));
}
writeInt (StoreInt , write_bytes [0 ..store_size ], write_value , .little );
}