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 standard library.
std › os › uefi › protocol › udp6 › Udp6 › receive Public Function receive Doc Source Public Function std.os.uefi.protocol.udp6.Udp6.receive
pub fn receive (self : *Udp6 , token : *CompletionToken ) ReceiveError !void Params File os/uefi/protocol/udp6.zig: 140
140
141
142
143
144
145
146
147
148
149
150
151
152
153 pub fn receive (self : *Udp6 , token : *CompletionToken ) ReceiveError !void {
switch (self ._receive (self , token )) {
.success => {},
.not_started => return error .NotStarted ,
.no_mapping => return error .NoMapping ,
.invalid_parameter => return error .InvalidParameter ,
.out_of_resources => return error .OutOfResources ,
.device_error => return error .DeviceError ,
.access_denied => return error .AccessDenied ,
.not_ready => return error .NotReady ,
.no_media => return error .NoMedia ,
else => |status | return uefi .unexpectedStatus (status ),
}
}