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

openVolume

Public Function
std.os.uefi.protocol.simple_file_system.SimpleFileSystem.openVolume
pub fn openVolume(self: *const SimpleFileSystem) OpenVolumeError!*File

Params

File

os/uefi/protocol/simple_file_system.zig:22
22
23
24
25
26
27
28
29
30
31
32
33
34
35
    pub fn openVolume(self: *const SimpleFileSystem) OpenVolumeError!*File {
        var root: *File = undefined;
        switch (self._open_volume(self, &root)) {
            .success => return root,
            .unsupported => return error.Unsupported,
            .no_media => return error.NoMedia,
            .device_error => return error.DeviceError,
            .volume_corrupted => return error.VolumeCorrupted,
            .access_denied => return error.AccessDenied,
            .out_of_resources => return error.OutOfResources,
            .media_changed => return error.MediaChanged,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }