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

close

Public Function
std.Io.Queue.close
pub fn close(q: *@This(), io: Io) void

After this is called, the queue enters a "closed" state. A closed queue always returns error.Closed for put attempts even when there is space in the buffer. However, existing elements of the queue are retrieved before error.Closed is returned.

Threadsafe.

Params

  • q: *@This()
  • io: Io

File

Io.zig:2392
2392
2393
2394
        pub fn close(q: *@This(), io: Io) void {
            q.type_erased.close(io);
        }