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 library itself.

isTty

Test whether the file refers to a terminal (similar to libc "isatty").

See also:

• enableAnsiEscapeCodes
• supportsAnsiEscapeCodes.

File.isTty

pub fn isTty(file: File, io: Io) Io.Cancelable!bool

File

lib/std/Io/File.zig:241

Code

pub fn isTty(file: File, io: Io) Io.Cancelable!bool {
    return io.vtable.fileIsTty(io.userdata, file);
}