Skip to content
Standard libraryZig 0.17.1Official documentation
Sourcestd/json/hashmap.zig

Source line 1

std.json.hashmap.Allocator

alias

Source line 2

Alias of std.mem.Allocator

std.json.hashmap.ArrayHashMap

type-function

Source line 13

A thin wrapper around std.array_hash_map.String that implements jsonParse, jsonParseFromValue, and jsonStringify. This is useful when your JSON schema has an object with arbitrary data keys instead of comptime-known struct field names.

pub fn ArrayHashMap(comptime T: type) type

Parameters

T: type

Fields

map: std.array_hash_map.String(T) = .empty

std.json.hashmap.ArrayHashMap.deinit

function

Source line 17

pub fn deinit(self: *@This(), allocator: Allocator) void

Parameters

self: *@This()
allocator: Allocator

std.json.hashmap.ArrayHashMap.jsonParse

function

Source line 21

pub fn jsonParse(allocator: Allocator, source: anytype, options: ParseOptions) !@This()

Parameters

allocator: Allocator
options: ParseOptions

std.json.hashmap.ArrayHashMap.jsonParseFromValue

function

Source line 52

pub fn jsonParseFromValue(allocator: Allocator, source: Value, options: ParseOptions) !@This()

Parameters

allocator: Allocator
source: Value
options: ParseOptions

std.json.hashmap.ArrayHashMap.jsonStringify

function

Source line 65

pub fn jsonStringify(self: @This(), jws: anytype) !void

Parameters

self: @This()

std.json.hashmap.innerParse

alias

Source line 5

Alias of std.json.static.innerParse

std.json.hashmap.innerParseFromValue

alias

Source line 6

Alias of std.json.static.innerParseFromValue

std.json.hashmap.ParseOptions

alias

Source line 4

Alias of std.json.static.ParseOptions

std.json.hashmap.std

alias

Source line 1

Alias of std

std.json.hashmap.Value

alias

Source line 7

Alias of std.json.dynamic.Value

Source code

std/json/hashmap.zig

const std = @import("std");
const Allocator = std.mem.Allocator;

const ParseOptions = @import("static.zig").ParseOptions;
const innerParse = @import("static.zig").innerParse;
const innerParseFromValue = @import("static.zig").innerParseFromValue;
const Value = @import("dynamic.zig").Value;

/// A thin wrapper around `std.array_hash_map.String` that implements
/// `jsonParse`, `jsonParseFromValue`, and `jsonStringify`.
/// This is useful when your JSON schema has an object with arbitrary data keys
/// instead of comptime-known struct field names.
pub fn ArrayHashMap(comptime T: type) type {
    return struct {
        map: std.array_hash_map.String(T) = .empty,

        pub fn deinit(self: *@This(), allocator: Allocator) void {
            self.map.deinit(allocator);
        }

        pub fn jsonParse(allocator: Allocator, source: anytype, options: ParseOptions) !@This() {
            var map: std.array_hash_map.String(T) = .empty;
            errdefer map.deinit(allocator);

            if (.object_begin != try source.next()) return error.UnexpectedToken;
            while (true) {
                const token = try source.nextAlloc(allocator, options.allocate.?);
                switch (token) {
                    inline .string, .allocated_string => |k| {
                        const gop = try map.getOrPut(allocator, k);
                        if (gop.found_existing) {
                            switch (options.duplicate_field_behavior) {
                                .use_first => {
                                    // Parse and ignore the redundant value.
                                    // We don't want to skip the value, because we want type checking.
                                    _ = try innerParse(T, allocator, source, options);
                                    continue;
                                },
                                .@"error" => return error.DuplicateField,
                                .use_last => {},
                            }
                        }
                        gop.value_ptr.* = try innerParse(T, allocator, source, options);
                    },
                    .object_end => break,
                    else => unreachable,
                }
            }
            return .{ .map = map };
        }

        pub fn jsonParseFromValue(allocator: Allocator, source: Value, options: ParseOptions) !@This() {
            if (source != .object) return error.UnexpectedToken;

            var map: std.array_hash_map.String(T) = .empty;
            errdefer map.deinit(allocator);

            var it = source.object.iterator();
            while (it.next()) |kv| {
                try map.put(allocator, kv.key_ptr.*, try innerParseFromValue(T, allocator, kv.value_ptr.*, options));
            }
            return .{ .map = map };
        }

        pub fn jsonStringify(self: @This(), jws: anytype) !void {
            try jws.beginObject();
            var it = self.map.iterator();
            while (it.next()) |kv| {
                try jws.objectField(kv.key_ptr.*);
                try jws.write(kv.value_ptr.*);
            }
            try jws.endObject();
        }
    };
}

test {
    _ = @import("hashmap_test.zig");
}