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 › write Public Function write Doc Source Public Function std.os.uefi.protocol.file.File.write
pub fn write (self : *File , buffer : []const u8 ) WriteError !usize Params self : *File buffer : []const u8 File os/uefi/protocol/file.zig: 156
156
157
158
159
160
161
162
163
164
165
166
167
168
169 pub fn write (self : *File , buffer : []const u8 ) WriteError !usize {
var size : usize = buffer .len ;
switch (self ._write (self , &size , buffer .ptr )) {
.success => return size ,
.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 ,
else => |status | return uefi .unexpectedStatus (status ),
}
}