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.

read

Synchronizes the contents of memory from file.

MemoryMap.read

pub fn read(mm: *MemoryMap, io: Io) File.ReadPositionalError!void

File

lib/std/Io/File/MemoryMap.zig:102

Code

pub fn read(mm: *MemoryMap, io: Io) File.ReadPositionalError!void {
    return io.vtable.fileMemoryMapRead(io.userdata, mm);
}