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 › base64 › testAllApis Private Function testAllApis Doc Source Private Function std.base64.testAllApis
fn testAllApis (codecs : Codecs , expected_decoded : []const u8 , expected_encoded : []const u8 ) !void Params codecs : Codecs expected_decoded : []const u8 expected_encoded : []const u8 File base64.zig: 496
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529 fn testAllApis (codecs : Codecs , expected_decoded : []const u8 , expected_encoded : []const u8 ) !void {
// Base64Encoder
{
// raw encode
var buffer : [0x100 ]u8 = undefined ;
const encoded = codecs .Encoder .encode (&buffer , expected_decoded );
try testing .expectEqualSlices (u8 , expected_encoded , encoded );
}
{
// stream encode
var buffer : [0x100 ]u8 = undefined ;
var writer : std .Io .Writer = .fixed (&buffer );
try codecs .Encoder .encodeWriter (&writer , expected_decoded );
try testing .expectEqualSlices (u8 , expected_encoded , writer .buffered ());
}
// Base64Decoder
{
var buffer : [0x100 ]u8 = undefined ;
const decoded = buffer [0 ..try codecs .Decoder .calcSizeForSlice (expected_encoded )];
try codecs .Decoder .decode (decoded , expected_encoded );
try testing .expectEqualSlices (u8 , expected_decoded , decoded );
}
// Base64DecoderWithIgnore
{
const decoder_ignore_nothing = codecs .decoderWithIgnore ("" );
var buffer : [0x100 ]u8 = undefined ;
const decoded = buffer [0 ..decoder_ignore_nothing .calcSizeUpperBound (expected_encoded .len )];
const written = try decoder_ignore_nothing .decode (decoded , expected_encoded );
try testing .expect (written <= decoded .len );
try testing .expectEqualSlices (u8 , expected_decoded , decoded [0 ..written ]);
}
}