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

remove

Doc Source

Public Function

std.hash_map.HashMap.remove

pub fn remove(self: *Self, key: K) bool

If there is an Entry with a matching key, it is deleted from the hash map, and this function returns true. Otherwise this function returns false.

TODO: answer the question in these doc comments, does this increase the unused capacity by one?

Params

self: *Self
key: K

File

hash_map.zig:420

420
421
422

        pub fn remove(self: *Self, key: K) bool {
            return self.unmanaged.removeContext(key, self.ctx);
        }