Zig 0.17.0-dev (Split by item) 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.
std › json › Stringify › testBasicWriteStream Private Function testBasicWriteStream Doc Source Private Function std.json.Stringify.testBasicWriteStream
fn testBasicWriteStream (w : *Stringify ) !void Params File json/Stringify.zig: 725
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770 fn testBasicWriteStream (w : *Stringify ) !void {
w .writer .end = 0 ;
try w .beginObject ();
try w .objectField ("object" );
var arena_allocator = std .heap .ArenaAllocator .init (std .testing .allocator );
defer arena_allocator .deinit ();
try w .write (try getJsonObject (arena_allocator .allocator ()));
try w .objectFieldRaw ("\"string\"" );
try w .write ("This is a string" );
try w .objectField ("array" );
try w .beginArray ();
try w .write ("Another string" );
try w .write (@as (i32 , 1 ));
try w .write (@as (f32 , 3.5 ));
try w .endArray ();
try w .objectField ("int" );
try w .write (@as (i32 , 10 ));
try w .objectField ("float" );
try w .write (@as (f32 , 3.5 ));
try w .endObject ();
const expected =
\\{
\\ "object": {
\\ "one": 1,
\\ "two": 2
\\ },
\\ "string": "This is a string",
\\ "array": [
\\ "Another string",
\\ 1,
\\ 3.5
\\ ],
\\ "int": 10,
\\ "float": 3.5
\\}
;
try std .testing .expectEqualStrings (expected , w .writer .buffered ());
}