Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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. Public Function

init

Public Function
std.Io.Dir.Reader.init
pub fn init(dir: Dir, buffer: []align(@alignOf(usize)) u8) Reader

Asserts that buffer has length at least min_buffer_len.

Params

  • dir: Dir
  • buffer: []align(@alignOf(usize)) u8

File

Io/Dir.zig:138
138
139
140
141
142
143
144
145
146
147
    pub fn init(dir: Dir, buffer: []align(@alignOf(usize)) u8) Reader {
        assert(buffer.len >= min_buffer_len);
        return .{
            .dir = dir,
            .state = .reset,
            .index = 0,
            .end = 0,
            .buffer = buffer,
        };
    }