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 library itself.

readPackedInt

Loads an integer from packed memory. Asserts that buffer contains at least bit_offset + @bitSizeOf(T) bits.

mem.readPackedInt

pub fn readPackedInt(comptime T: type, bytes: []const u8, bit_offset: usize, endian: Endian) T

File

lib/std/mem.zig:1992

Code

pub fn readPackedInt(comptime T: type, bytes: []const u8, bit_offset: usize, endian: Endian) T {
    switch (endian) {
        .little => return readPackedIntLittle(T, bytes, bit_offset),
        .big => return readPackedIntBig(T, bytes, bit_offset),
    }
}