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 › drain Private Function drain Doc Source Private Function std.compress.flate.Compress.Raw.drain
fn drain (w : *Writer , data : []const []const u8 , splat : usize ) Writer .Error !usize Params w : *Writer data : []const []const u8 splat : usize File compress/flate/Compress.zig: 1631
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739 fn drain (w : *Writer , data : []const []const u8 , splat : usize ) Writer .Error !usize {
errdefer w .* = .failing ;
const r : *Raw = @fieldParentPtr ("writer" , w );
const min_block = @min (w .buffer .len , max_block_size );
const pattern = data [data .len - 1 ];
var partial_header : [5 ]u8 = undefined ;
var vecs : [16 ][]const u8 = undefined ;
var vecs_n : usize = 0 ;
const data_bytes = Writer .countSplat (data , splat );
const total_bytes = w .end + data_bytes ;
var rem_bytes = total_bytes ;
var rem_splat = splat ;
var rem_data = data ;
var rem_data_elem : []const u8 = w .buffered ();
assert (rem_bytes > min_block );
while (rem_bytes > min_block ) { // not >= to allow `min_block` blocks to be marked as final
// also, it handles the case of `min_block` being zero (no buffer)
const block_size : u16 = @min (rem_bytes , max_block_size );
rem_bytes -= block_size ;
if (vecs_n == vecs .len ) {
try r .output .writeVecAll (&vecs );
vecs_n = 0 ;
}
vecs [vecs_n ] = if (block_size == 65535 )
&full_header
else header : {
partial_header [0 ] = BlockHeader .int (.{ .final = false , .kind = .stored });
mem .writeInt (u16 , partial_header [1 ..3 ], block_size , .little );
mem .writeInt (u16 , partial_header [3 ..5 ], ~block_size , .little );
break :header &partial_header ;
};
vecs_n += 1 ;
var block_limit : Io .Limit = .limited (block_size );
while (true ) {
if (vecs_n == vecs .len ) {
try r .output .writeVecAll (&vecs );
vecs_n = 0 ;
}
const vec = block_limit .sliceConst (rem_data_elem );
vecs [vecs_n ] = vec ;
vecs_n += 1 ;
r .hasher .update (vec );
const is_pattern = rem_splat != splat and vec .len == pattern .len ;
if (is_pattern ) assert (pattern .len != 0 ); // exceeded countSplat
if (!is_pattern or rem_splat == 0 or pattern .len > @backingInt (block_limit ) / 2 ) {
rem_data_elem = rem_data_elem [vec .len ..];
block_limit = block_limit .subtract (vec .len ).?;
if (rem_data_elem .len == 0 ) {
rem_data_elem = rem_data [0 ];
if (rem_data .len != 1 ) {
rem_data = rem_data [1 ..];
} else if (rem_splat != 0 ) {
rem_splat -= 1 ;
} else {
// All of `data` has been consumed.
assert (block_limit == .nothing );
assert (rem_bytes == 0 );
// Since `rem_bytes` and `block_limit` are zero, these won't be used.
rem_data = undefined ;
rem_data_elem = undefined ;
rem_splat = undefined ;
}
}
if (block_limit == .nothing ) break ;
} else {
const out_splat = @backingInt (block_limit ) / pattern .len ;
assert (out_splat >= 2 );
try r .output .writeSplatAll (vecs [0 ..vecs_n ], out_splat );
for (1 ..out_splat ) |_ | r .hasher .update (vec );
vecs_n = 0 ;
block_limit = block_limit .subtract (pattern .len * out_splat ).?;
if (rem_splat >= out_splat ) {
// `out_splat` contains `rem_data`, however one more needs subtracted
// anyways since the next pattern is also being taken.
rem_splat -= out_splat ;
} else {
// All of `data` has been consumed.
assert (block_limit == .nothing );
assert (rem_bytes == 0 );
// Since `rem_bytes` and `block_limit` are zero, these won't be used.
rem_data = undefined ;
rem_data_elem = undefined ;
rem_splat = undefined ;
}
if (block_limit == .nothing ) break ;
}
}
}
if (vecs_n != 0 ) { // can be the case if a splat was sent
try r .output .writeVecAll (vecs [0 ..vecs_n ]);
}
if (rem_bytes > data_bytes ) {
assert (rem_bytes - data_bytes == rem_data_elem .len );
assert (&rem_data_elem [0 ] == &w .buffer [total_bytes - rem_bytes ]);
}
return w .consume (total_bytes - rem_bytes );
}