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.

init

Initialize an HTTP server that can respond to multiple requests on the same connection.

The buffer of in must be large enough to store the client's entire HTTP header, otherwise receiveHead returns error.HttpHeadersOversize.

The returned Server is ready for receiveHead to be called.

Server.init

pub fn init(in: *Reader, out: *Writer) Server

File

lib/std/http/Server.zig:25

Code

pub fn init(in: *Reader, out: *Writer) Server {
    return .{
        .reader = .{
            .in = in,
            .state = .ready,
            // Populated when `http.Reader.bodyReader` is called.
            .interface = undefined,
            .max_head_len = in.buffer.len,
        },
        .out = out,
    };
}