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 › rng › Rng › getRNG Public Function getRNG Doc Source Public Function std.os.uefi.protocol.rng.Rng.getRNG
pub fn getRNG (self : *const Rng , algo : ?*align (8 ) const Guid , value : []u8 ) GetRNGError !void Params self : *const Rng algo : ?*align (8 ) const Guid value : []u8 File os/uefi/protocol/rng.zig: 37
37
38
39
40
41
42
43
44
45
46 pub fn getRNG (self : *const Rng , algo : ?*align (8 ) const Guid , value : []u8 ) GetRNGError !void {
switch (self ._get_rng (self , algo , value .len , value .ptr )) {
.success => {},
.unsupported => return error .Unsupported ,
.device_error => return error .DeviceError ,
.not_ready => return error .NotReady ,
.invalid_parameter => return error .InvalidParameter ,
else => |status | return uefi .unexpectedStatus (status ),
}
}
Produces and returns an RNG value using either the default or specified RNG algorithm.