Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move BitList and BitVector to ethereum_ssz #25

Merged
merged 7 commits into from
Sep 3, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Also export Fixed and Variable
  • Loading branch information
macladson committed Jul 26, 2024
commit f088a3aa00af46b7caaa110f989d2472b0222a71
3 changes: 2 additions & 1 deletion ssz/src/lib.rs
Original file line number Diff line number Diff line change
@@ -40,7 +40,8 @@ mod encode;
pub mod legacy;
mod union_selector;

pub use bitfield::{BitList, BitVector};
#[doc(hidden)]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've hidden these types in the docs which I believe means the current documentation should remain unchanged.

Since we are re-exporting the Bitfield types in ssz_types the documentation for them will still exist in that crate. Like it does now.

There might be an argument for moving the documentation across (or duplicating it), but I'm loosely in favour of this approach for now.

pub use bitfield::{BitList, BitVector, Fixed, Variable};
pub use decode::{
impls::decode_list_of_variable_length_items, read_offset, split_union_bytes,
try_from_iter::TryFromIter, Decode, DecodeError, SszDecoder, SszDecoderBuilder,