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

peekStructPointer

Doc Source

Public Function

std.Io.Reader.peekStructPointer

pub fn peekStructPointer(r: *Reader, comptime T: type) Error!*align(1) T

Obtains an unaligned pointer to the beginning of the stream, reinterpreted as a pointer to the provided type, without advancing the seek position.

Asserts the buffer was initialized with a capacity at least @sizeOf(T).

Params

r: *Reader
T: type

Errors

ReadFailed: See the Reader implementation for detailed diagnostics.
EndOfStream

File

Io/Reader.zig:1212

pub fn peekStructPointer(r: *Reader, comptime T: type) Error!*align(1) T {
    // Only extern and packed structs have defined in-memory layout.
    comptime assert(@typeInfo(T).@"struct".layout != .auto);
    return @ptrCast(try r.peekArray(@sizeOf(T)));
}