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.

lookup

Adds any number of LookupResult.address into resolved, and exactly one LookupResult.canonical_name.

Guaranteed not to block if provided queue has capacity at least 16.

Closes resolved before return, even on error.

Asserts resolved is not closed until this call returns.

HostName.lookup

pub fn lookup(
    host_name: HostName,
    io: Io,
    resolved: *Io.Queue(LookupResult),
    options: LookupOptions,
) LookupError!void

File

lib/std/Io/net/HostName.zig:174

Code

pub fn lookup(
    host_name: HostName,
    io: Io,
    resolved: *Io.Queue(LookupResult),
    options: LookupOptions,
) LookupError!void {
    return io.vtable.netLookup(io.userdata, host_name, resolved, options);
}