Skip to content

Commit 06762e0

Browse files
committed
Update doc
1 parent 475d04b commit 06762e0

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/primitives/iter.rs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,13 @@ pub trait Fe32IterExt: Sized + Iterator<Item = Fe32> {
6666

6767
/// Adapts the `Fe32` iterator to output bytes instead.
6868
///
69-
/// If the total number of bits is not a multiple of 8, trailing bits
70-
/// are padded with the needed amount of zeroes and converted.
69+
/// Similar to `fes_to_bytes`, but in this variant trailing bits are kept.
70+
///
71+
/// If the last bits do not fill up the last output byte completely, they
72+
/// are not dropped, but kept, and the last byte is padded with zero bits.
73+
/// In effect this is the same as if the input was padded with zero values
74+
/// (1 or 2), such that there are enough zero bits to fill the last byte.
75+
/// The output is either the same as of `fes_to_bytes`, or has 1 extra byte.
7176
#[inline]
7277
fn fes_to_bytes_zeropad(mut self) -> FesToBytes<Self> {
7378
FesToBytes {

0 commit comments

Comments
 (0)