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 › tar › PaxIterator › next Public Function next Doc Source Public Function std.tar.PaxIterator.next
pub fn next (self : *Self ) !?Attribute Params File tar.zig: 531
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569 pub fn next (self : *Self ) !?Attribute {
// Pax extended header consists of one or more attributes, each constructed as follows:
// "%d %s=%s\n", <length>, <keyword>, <value>
while (self .size > 0 ) {
const length_buf = try self .reader .takeSentinel (' ' );
const length = try std .fmt .parseInt (usize , length_buf , 10 ); // record length in bytes
const keyword = try self .reader .takeSentinel ('=' );
if (hasNull (keyword )) return error .PaxNullInKeyword ;
// calculate value_len
const value_start = length_buf .len + keyword .len + 2 ; // 2 separators
if (length < value_start + 1 or self .size < length ) return error .UnexpectedEndOfStream ;
const value_len = length - value_start - 1 ; // \n separator at end
self .size -= length ;
const kind : PaxAttributeKind = if (eql (keyword , "path" ))
.path
else if (eql (keyword , "linkpath" ))
.linkpath
else if (eql (keyword , "size" ))
.size
else {
try self .reader .discardAll (value_len );
try validateAttributeEnding (self .reader );
continue ;
};
if (kind == .size and value_len > pax_max_size_attr_len ) {
return error .PaxSizeAttrOverflow ;
}
return .{
.kind = kind ,
.len = value_len ,
.reader = self .reader ,
};
}
return null ;
}