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 › file › File › setInfo Public Function setInfo Doc Source Public Function std.os.uefi.protocol.file.File.setInfo
pub fn setInfo (
self : *File ,
comptime info : std .meta .Tag (Info ),
data : *const @FieldType (Info , @tagName (info )),
) SetInfoError !void Params File os/uefi/protocol/file.zig: 243
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272 pub fn setInfo (
self : *File ,
comptime info : std .meta .Tag (Info ),
data : *const @FieldType (Info , @tagName (info )),
) SetInfoError !void {
const InfoType = @FieldType (Info , @tagName (info ));
const attached_str : [*:0 ]const u16 = switch (info ) {
.file => data .getFileName (),
.file_system , .volume_label => data .getVolumeLabel (),
};
const attached_str_len = std .mem .sliceTo (attached_str , 0 ).len ;
// add the length (not +1 for sentinel) because `@sizeOf(InfoType)`
// already contains the first utf16 char
const len = @sizeOf (InfoType ) + (attached_str_len * 2 );
switch (self ._set_info (self , &InfoType .guid , len , @ptrCast (data ))) {
.success => {},
.unsupported => return error .Unsupported ,
.no_media => return error .NoMedia ,
.device_error => return error .DeviceError ,
.volume_corrupted => return error .VolumeCorrupted ,
.write_protected => return error .WriteProtected ,
.access_denied => return error .AccessDenied ,
.volume_full => return error .VolumeFull ,
.bad_buffer_size => return error .BadBufferSize ,
else => |status | return uefi .unexpectedStatus (status ),
}
}