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

orderedRemove

Public Function
std.process.Environ.Map.orderedRemove
pub fn orderedRemove(self: *Map, key: []const u8) bool

If there is an entry with a matching key, it is deleted from the map. The entry is removed from the underlying array by shifting all elements forward, thereby maintaining the current ordering.

Returns true if an entry was removed, false otherwise.

This invalidates the value returned by get() for this key. On Windows, asserts that key is valid WTF-8.

Params

  • self: *Map
  • key: []const u8

File

process/Environ.zig:322
322
323
324
325
326
327
328
329
    pub fn orderedRemove(self: *Map, key: []const u8) bool {
        assert(validateKeyForFetch(key));
        const kv = self.array_hash_map.fetchOrderedRemove(key) orelse return false;
        const gpa = self.allocator;
        gpa.free(kv.key);
        gpa.free(kv.value);
        return true;
    }