Struct SidecarBuilder

pub struct SidecarBuilder<T = SimpleCoder> { /* private fields */ }

Build a BlobTransactionSidecar from an arbitrary amount of data.

This is useful for creating a sidecar from a large amount of data, which is then split into blobs. It delays KZG commitments and proofs until all data is ready.

Implementations

impl<'a, T: Arbitrary<'a> + Clone> SidecarBuilder<T>

pub fn build_arbitrary(&self) -> BlobTransactionSidecar

Available on crate feature arbitrary only.

Builds an arbitrary realization for BlobTransactionSidecar.

impl<T: SidecarCoder + Default> SidecarBuilder<T>

pub fn new() -> Self

Instantiate a new builder and new coder instance.

By default, this allocates space for 2 blobs (256 KiB). If you want to preallocate a specific number of blobs, use SidecarBuilder::with_capacity.

pub fn from_slice(data: &[u8]) -> Self

Create a new builder from a slice of data by calling SidecarBuilder::from_coder_and_data

pub fn with_capacity(capacity: usize) -> Self

Create a new builder with a pre-allocated capacity. This capacity is measured in blobs, each of which is 128 KiB.

impl<T: SidecarCoder> SidecarBuilder<T>

pub fn from_coder_and_capacity(coder: T, capacity: usize) -> Self

Instantiate a new builder with the provided coder and capacity. This capacity is measured in blobs, each of which is 128 KiB.

pub const fn len(&self) -> usize

Calculate the length of bytes used by field elements in the builder.

This is always strictly greater than the number of bytes that have been ingested.

pub const fn is_empty(&self) -> bool

Check if the builder is empty.

pub fn from_coder_and_data(coder: T, data: &[u8]) -> Self

Create a new builder from a slice of data.

pub fn ingest(&mut self, data: &[u8])

Ingest a slice of data into the builder.

pub fn build_with_settings( self, settings: &KzgSettings, ) -> Result<BlobTransactionSidecar, Error>

Available on crate feature kzg only.

Build the sidecar from the data with the provided settings.

pub fn build(self) -> Result<BlobTransactionSidecar, Error>

Available on crate feature kzg only.

Build the sidecar from the data, with default (Ethereum Mainnet) settings.

pub fn take(self) -> Vec<Blob>

Take the blobs from the builder, without committing them to a KZG proof.

Trait Implementations

impl<T: Clone> Clone for SidecarBuilder<T>

fn clone(&self) -> SidecarBuilder<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for SidecarBuilder<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> Default for SidecarBuilder<T>

where T: Default + SidecarCoder,

fn default() -> Self

Returns the “default value” for a type.

impl<T: SidecarCoder> From<T> for SidecarBuilder<T>

fn from(coder: T) -> Self

Instantiate a new builder with the provided coder.

This is equivalent to calling SidecarBuilder::from_coder_and_capacity with a capacity of 1. If you want to preallocate a specific number of blobs, use SidecarBuilder::from_coder_and_capacity.

impl<T, R> FromIterator<R> for SidecarBuilder<T>

where T: SidecarCoder + Default, R: AsRef<[u8]>,

fn from_iter<I: IntoIterator<Item = R>>(iter: I) -> Self

Creates a value from an iterator.