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

takeStruct

Doc Source

Public Function

std.Io.Reader.takeStruct

pub inline fn takeStruct(r: *Reader, comptime T: type, endian: std.builtin.Endian) Error!T

Params

r: *Reader
T: type
endian: std.builtin.Endian

Errors

ReadFailed: See the Reader implementation for detailed diagnostics.
EndOfStream

File

Io/Reader.zig:1224

pub inline fn takeStruct(r: *Reader, comptime T: type, endian: std.builtin.Endian) Error!T {
    switch (@typeInfo(T)) {
        .@"struct" => |info| switch (info.layout) {
            .auto => @compileError("ill-defined memory layout"),
            .@"extern" => {
                var res: T = undefined;
                try r.readSliceEndian(T, (&res)[0..1], endian);
                return res;
            },
            .@"packed" => {
                return @bitCast(try takeInt(r, info.backing_integer.?, endian));
            },
        },
        else => @compileError("not a struct"),
    }
}