Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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. Public Function

readInt

Public Function
std.mem.readInt
pub inline fn readInt(comptime T: type, buffer: *const [@divExact(@typeInfo(T).int.bits, 8)]u8, endian: Endian) T

Params

  • T: type
  • buffer: *const [@divExact(@typeInfo(T).int.bits, 8)]u8
  • endian: Endian

File

mem.zig:1911
1911
1912
1913
1914
1915
1916
1917
1918
1919
pub inline fn readInt(comptime T: type, buffer: *const [@divExact(@typeInfo(T).int.bits, 8)]u8, endian: Endian) T {
    // Zig's logical bit order aligns with a little-endian byte array, so when reading in big-endian
    // we must `@byteSwap` the int after we `@bitCast` to it.
    const little_val: T = @bitCast(buffer.*);
    return switch (endian) {
        .little => little_val,
        .big => @byteSwap(little_val),
    };
}