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 › Io › LockedStderr Public Struct LockedStderr Doc Source Public Struct std.Io.LockedStderr
pub const LockedStderr = struct Fields Functions File Io.zig: 2598
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625 pub const LockedStderr = struct {
file_writer : *File .Writer ,
terminal_mode : Terminal .Mode ,
pub fn terminal (ls : LockedStderr ) Terminal {
return .{
.writer = &ls .file_writer .interface ,
.mode = ls .terminal_mode ,
};
}
pub fn clear (ls : LockedStderr , buffer : []u8 ) Cancelable !void {
const fw = ls .file_writer ;
std .Progress .clearWrittenWithEscapeCodes (fw ) catch |err | switch (err ) {
error .WriteFailed => switch (fw .err .?) {
error .Canceled => |e | return e ,
else => {},
},
};
fw .interface .flush () catch |err | switch (err ) {
error .WriteFailed => switch (fw .err .?) {
error .Canceled => |e | return e ,
else => {},
},
};
fw .interface .buffer = buffer ;
}
}