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

readSize

Public Function
std.os.uefi.protocol.file.File.readSize
pub fn readSize(self: *File) ReadError!usize

Params

File

os/uefi/protocol/file.zig:128
128
129
130
131
132
133
134
135
136
137
138
    pub fn readSize(self: *File) ReadError!usize {
        const zerobuf: [0]u8 = undefined;
        var size: usize = 0;
        switch (self._read(self, &size, &zerobuf)) {
            .success, .buffer_too_small => return size,
            .no_media => return error.NoMedia,
            .device_error => return error.DeviceError,
            .volume_corrupted => return error.VolumeCorrupted,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }