Struct TableCommitment

pub struct TableCommitment<C>
where
    C: Commitment,
{ /* private fields */ }

Commitment for an entire table, with column and table metadata.

Unlike ColumnCommitments, all columns in this commitment must have the same length.

Implementations

impl<C: Commitment> TableCommitment<C>

pub fn try_append_record_batch( &mut self, batch: &RecordBatch, setup: &C::PublicSetup<'_>, ) -> Result<(), AppendRecordBatchTableCommitmentError>

Append an arrow RecordBatch to the existing TableCommitment.

The row offset is assumed to be the end of the TableCommitment’s current range.

Will error on a variety of mismatches, or if the provided columns have mixed length.

pub fn try_from_record_batch( batch: &RecordBatch, setup: &C::PublicSetup<'_>, ) -> Result<TableCommitment<C>, RecordBatchToColumnsError>

Returns a TableCommitment to the provided arrow RecordBatch.

pub fn try_from_record_batch_with_offset( batch: &RecordBatch, offset: usize, setup: &C::PublicSetup<'_>, ) -> Result<TableCommitment<C>, RecordBatchToColumnsError>

Returns a TableCommitment to the provided arrow RecordBatch with the given row offset.

impl<C: Commitment> TableCommitment<C>

pub fn from_accessor_with_max_bounds( table_ref: &TableRef, columns: &[ColumnField], accessor: &impl CommitmentAccessor<C>, ) -> Self

Create a new TableCommitment for a table from a commitment accessor.

pub fn try_new( column_commitments: ColumnCommitments<C>, range: Range<usize>, ) -> Result<Self, NegativeRange>

Construct a new TableCommitment.

Will error if the range is “negative”, i.e. if its end < start.

pub fn column_commitments(&self) -> &ColumnCommitments<C>

Returns a reference to this type’s internal ColumnCommitments.

pub fn range(&self) -> &Range<usize>

Returns a reference to the range of rows this type commits to.

pub fn num_columns(&self) -> usize

Returns the number of columns in the committed table.

pub fn num_rows(&self) -> usize

Returns the number of rows that have been committed to.

pub fn try_from_columns_with_offset<'a, COL>( columns: impl IntoIterator<Item = (&'a Ident, COL)>, offset: usize, setup: &C::PublicSetup<'_>, ) -> Result<TableCommitment<C>, TableCommitmentFromColumnsError>

where COL: Into<CommittableColumn<'a>>,

Returns a TableCommitment to the provided columns with the given row offset.

Provided columns must have the same length and no duplicate idents.

pub fn from_owned_table_with_offset<S>( owned_table: &OwnedTable<S>, offset: usize, setup: &C::PublicSetup<'_>, ) -> TableCommitment<C>

where S: Scalar,

Returns a TableCommitment to the provided table with the given row offset.

pub fn try_append_rows<'a, COL>( &mut self, columns: impl IntoIterator<Item = (&'a Ident, COL)>, setup: &C::PublicSetup<'_>, ) -> Result<(), AppendTableCommitmentError>

where COL: Into<CommittableColumn<'a>>,

Append rows of data from the provided columns to the existing TableCommitment.

The row offset is assumed to be the end of the TableCommitment’s current range.

Will error on a variety of mismatches, or if the provided columns have mixed length.

pub fn append_owned_table<S>( &mut self, owned_table: &OwnedTable<S>, setup: &C::PublicSetup<'_>, ) -> Result<(), ColumnCommitmentsMismatch>

where S: Scalar,

Append data of the provided table to the exiting TableCommitment.

Will error on a variety of mismatches. See ColumnCommitmentsMismatch for an enumeration of these errors.

Panics

Panics if owned_table has duplicate idents. Panics if owned_table contains columns of mixed length.

pub fn try_extend_columns<'a, COL>( &mut self, columns: impl IntoIterator<Item = (&'a Ident, COL)>, setup: &C::PublicSetup<'_>, ) -> Result<(), TableCommitmentFromColumnsError>

where COL: Into<CommittableColumn<'a>>,

Add new columns to this TableCommitment.

Columns must have the same length as the current commitment and no duplicate idents.

pub fn try_add( self, other: Self, ) -> Result<Self, TableCommitmentArithmeticError>

where Self: Sized,

Add two TableCommitments together.

self must end where other begins, or vice versa. Otherwise, TableCommitmentArithmeticError::NonContiguous is returned.

This will also error on a variety of mismatches. See ColumnCommitmentsMismatch for an enumeration of these errors.

pub fn try_sub( self, other: Self, ) -> Result<Self, TableCommitmentArithmeticError>

where Self: Sized,

Subtract two TableCommitments.

self and other must begin at the same row number or end at the same row number. Otherwise, TableCommitmentArithmeticError::NonContiguous is returned.

Furthermore, other’s range must be smaller or equal to self’s. Otherwise, TableCommitmentArithmeticError::NegativeRange is returned.

This will also error on a variety of mismatches. See ColumnCommitmentsMismatch for an enumeration of these errors.

Trait Implementations

impl<C> Clone for TableCommitment<C>

where C: Commitment + Clone,

fn clone(&self) -> TableCommitment<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> Debug for TableCommitment<C>

where C: Commitment + Debug,

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

Formats the value using the given formatter.

impl<C> Default for TableCommitment<C>

where C: Commitment + Default,

fn default() -> TableCommitment<C>

Returns the “default value” for a type.

impl<'de, C> Deserialize<'de> for TableCommitment<C>

where C: Commitment + Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<C> PartialEq for TableCommitment<C>

where C: Commitment + PartialEq,

fn eq(&self, other: &TableCommitment<C>) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<C> Serialize for TableCommitment<C>

where C: Commitment + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<C> Eq for TableCommitment<C>

where C: Commitment + Eq,

impl<C> StructuralPartialEq for TableCommitment<C>

where C: Commitment,