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

getData

Public Function
std.os.uefi.protocol.ip6_config.Ip6Config.getData
pub fn getData(
        self: *const Ip6Config,
        comptime data_type: std.meta.Tag(DataType),
    ) GetDataError!@FieldType(DataType, @tagName(data_type))

Params

File

os/uefi/protocol/ip6_config.zig:63
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
    pub fn getData(
        self: *const Ip6Config,
        comptime data_type: std.meta.Tag(DataType),
    ) GetDataError!@FieldType(DataType, @tagName(data_type)) {
        const DataPayload = @FieldType(DataType, @tagName(data_type));

        var payload: DataPayload = undefined;
        var payload_size: usize = @sizeOf(DataPayload);

        switch (self._get_data(self, data_type, &payload_size, @ptrCast(&payload))) {
            .success => return payload,
            .invalid_parameter => return error.InvalidParameter,
            .buffer_too_small => return error.BufferTooSmall,
            .not_ready => return error.NotReady,
            .not_found => return error.NotFound,
            else => |status| return uefi.unexpectedStatus(status),
        }
    }