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 › crypto › codecs › base64_hex_ct › base64 › decodeAny Private Function decodeAny Doc Source Private Function std.crypto.codecs.base64_hex_ct.base64.decodeAny
fn decodeAny (
bin : []u8 ,
encoded : []const u8 ,
comptime variant : Variant ,
ignored_chars : ?StaticBitSet (256 ),
) error Params File crypto/codecs/base64_hex_ct.zig: 341
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395 fn decodeAny (
bin : []u8 ,
encoded : []const u8 ,
comptime variant : Variant ,
ignored_chars : ?StaticBitSet (256 ),
) error { NoSpaceLeft , InvalidCharacter , InvalidPadding }![]const u8 {
var acc : u16 = 0 ;
var acc_len : u4 = 0 ;
var bin_pos : usize = 0 ;
var premature_end : ?usize = null ;
const urlsafe = variant .urlsafe_alphabet ;
for (encoded , 0 ..) |c , b64_pos | {
const d = byteFromChar (c , urlsafe );
if (d == 0xff ) {
if (ignored_chars ) |set | {
if (set .isSet (c )) continue ;
}
premature_end = b64_pos ;
break ;
}
acc = (acc << 6 ) + d ;
acc_len += 6 ;
if (acc_len >= 8 ) {
acc_len -= 8 ;
if (bin_pos >= bin .len ) {
return error .NoSpaceLeft ;
}
bin [bin_pos ] = @truncate (acc >> acc_len );
bin_pos += 1 ;
}
}
if (acc_len > 4 or (acc & ((@as (u16 , 1 ) << acc_len ) -% 1 )) != 0 ) {
return error .InvalidCharacter ;
}
const padding_len = acc_len / 2 ;
if (premature_end ) |pos | {
const remaining =
if (variant .padding )
try skipPadding (encoded [pos ..], padding_len , ignored_chars )
else
encoded [pos ..];
if (ignored_chars ) |set | {
for (remaining ) |c | {
if (!set .isSet (c )) {
return error .InvalidCharacter ;
}
}
} else if (remaining .len != 0 ) {
return error .InvalidCharacter ;
}
} else if (variant .padding and padding_len != 0 ) {
return error .InvalidPadding ;
}
return bin [0 ..bin_pos ];
}