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 › compress › flate › Compress › Raw › rebaseInner Private Function rebaseInner Doc Source Private Function std.compress.flate.Compress.Raw.rebaseInner
fn rebaseInner (w : *Writer , preserve : usize , capacity : usize , eos : bool ) Writer .Error !void Params w : *Writer preserve : usize capacity : usize eos : bool File compress/flate/Compress.zig: 1757
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818 fn rebaseInner (w : *Writer , preserve : usize , capacity : usize , eos : bool ) Writer .Error !void {
const r : *Raw = @fieldParentPtr ("writer" , w );
assert (preserve + capacity <= w .buffer .len );
if (eos ) assert (capacity == w .buffer .len );
var partial_header : [5 ]u8 = undefined ;
var footer_buf : [8 ]u8 = undefined ;
const preserved = @min (w .end , preserve );
var remaining = w .buffer [0 .. w .end - preserved ];
var vecs : [16 ][]const u8 = undefined ;
var vecs_n : usize = 0 ;
while (remaining .len > max_block_size ) { // not >= so there is always a block down below
if (vecs_n == vecs .len ) {
try r .output .writeVecAll (&vecs );
vecs_n = 0 ;
}
vecs [vecs_n + 0 ] = &full_header ;
vecs [vecs_n + 1 ] = remaining [0 ..max_block_size ];
r .hasher .update (vecs [vecs_n + 1 ]);
vecs_n += 2 ;
remaining = remaining [max_block_size ..];
}
// eos check required for empty block
if (w .buffer .len - (remaining .len + preserved ) < capacity or eos ) {
// A partial write is necessary to reclaim enough buffer space
const block_size : u16 = @intCast (remaining .len );
partial_header [0 ] = BlockHeader .int (.{ .final = eos , .kind = .stored });
mem .writeInt (u16 , partial_header [1 ..3 ], block_size , .little );
mem .writeInt (u16 , partial_header [3 ..5 ], ~block_size , .little );
if (vecs_n == vecs .len ) {
try r .output .writeVecAll (&vecs );
vecs_n = 0 ;
}
vecs [vecs_n + 0 ] = &partial_header ;
vecs [vecs_n + 1 ] = remaining [0 ..block_size ];
r .hasher .update (vecs [vecs_n + 1 ]);
vecs_n += 2 ;
remaining = remaining [block_size ..];
assert (remaining .len == 0 );
if (eos and r .hasher != .raw ) {
// the footer is done here instead of `flush` so it can be included in the vector
var footer_w : Writer = .fixed (&footer_buf );
r .hasher .writeFooter (&footer_w ) catch unreachable ;
assert (footer_w .end != 0 );
if (vecs_n == vecs .len ) {
try r .output .writeVecAll (&vecs );
return r .output .writeAll (footer_w .buffered ());
} else {
vecs [vecs_n ] = footer_w .buffered ();
vecs_n += 1 ;
}
}
}
try r .output .writeVecAll (vecs [0 ..vecs_n ]);
_ = w .consume (w .end - preserved - remaining .len );
}