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

readKeyStroke

Public Function
std.os.uefi.protocol.simple_text_input.SimpleTextInput.readKeyStroke
pub fn readKeyStroke(self: *SimpleTextInput) ReadKeyStrokeError!Key.Input

Reads the next keystroke from the input device.

Params

File

os/uefi/protocol/simple_text_input.zig:31
31
32
33
34
35
36
37
38
39
40
    pub fn readKeyStroke(self: *SimpleTextInput) ReadKeyStrokeError!Key.Input {
        var key: Key.Input = undefined;
        switch (self._read_key_stroke(self, &key)) {
            .success => return key,
            .not_ready => return error.NotReady,
            .device_error => return error.DeviceError,
            .unsupported => return error.Unsupported,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }