cerc-io/lighthouse
16
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Add comments after self-review

Browse Source
This commit is contained in:
Paul Hauner 2019-07-09 20:28:19 +10:00
parent 090133b088
commit daa8916e6b
No known key found for this signature in database
GPG Key ID: 303E4494BB28068C
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
eth2/utils/ssz_types/src/bitfield.rs
View File

@ -8,7 +8,7 @@ use typenum::Unsigned;
/// A marker trait applied to `BitList` and `BitVector` that defines the behaviour of a `Bitfield`. /// A marker trait applied to `BitList` and `BitVector` that defines the behaviour of a `Bitfield`.
pub trait BitfieldBehaviour: Clone {} pub trait BitfieldBehaviour: Clone {}
/// A marker struct used to define SSZ `BitList` functionality on a `Bitfield`. /// A marker struct used to declare SSZ `BitList` behaviour on a `Bitfield`.
/// ///
/// See the [`Bitfield`](struct.Bitfield.html) docs for usage. /// See the [`Bitfield`](struct.Bitfield.html) docs for usage.
#[derive(Clone, PartialEq, Debug)] #[derive(Clone, PartialEq, Debug)]
@ -16,7 +16,7 @@ pub struct BitList<N> {
_phantom: PhantomData<N>, _phantom: PhantomData<N>,
} }
/// A marker struct used to define SSZ `BitVector` functionality on a `Bitfield`. /// A marker struct used to declare SSZ `BitVector` behaviour on a `Bitfield`.
/// ///
/// See the [`Bitfield`](struct.Bitfield.html) docs for usage. /// See the [`Bitfield`](struct.Bitfield.html) docs for usage.
#[derive(Clone, PartialEq, Debug)] #[derive(Clone, PartialEq, Debug)]
@ -415,10 +415,14 @@ impl<T: BitfieldBehaviour> Bitfield<T> {
} }
} }
/// Returns the minimum required bytes to represent a given number of bits.
///
/// `bit_len == 0` requires a single byte.
fn bytes_for_bit_len(bit_len: usize) -> usize { fn bytes_for_bit_len(bit_len: usize) -> usize {
(bit_len + 7) / 8 (bit_len + 7) / 8
} }
/// An iterator over the bits in a `Bitfield`.
pub struct BitIter<'a, T> { pub struct BitIter<'a, T> {
bitfield: &'a Bitfield<T>, bitfield: &'a Bitfield<T>,
i: usize, i: usize,