Struct ColumnCommitments

pub struct ColumnCommitments<C> { /* private fields */ }

Commitments for a collection of columns with some metadata.

These columns do not need to belong to the same table, and can have differing lengths.

Implementations

impl<C: Commitment> ColumnCommitments<C>

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

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

pub fn commitments(&self) -> &Vec<C>

Returns a reference to the stored commitments.

pub fn column_metadata(&self) -> &ColumnCommitmentMetadataMap

Returns a reference to the stored column metadata.

pub fn len(&self) -> usize

Returns the number of columns.

pub fn is_empty(&self) -> bool

Returns true if there are no columns.

pub fn get_commitment(&self, identifier: &Identifier) -> Option<C>

Returns the commitment with the given identifier.

pub fn get_metadata( &self, identifier: &Identifier, ) -> Option<&ColumnCommitmentMetadata>

Returns the metadata for the commitment with the given identifier.

pub fn iter( &self, ) -> Map<Zip<<&'_ ColumnCommitmentMetadataMap as IntoIterator>::IntoIter, Iter<'_, C>>, fn(_: ((&'_ Identifier, &'_ ColumnCommitmentMetadata), &'_ C)) -> (&'_ Identifier, &'_ ColumnCommitmentMetadata, &'_ C)>

Iterate over the metadata and commitments by reference.

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

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

Returns ColumnCommitments to the provided columns using the given generator offset

pub fn try_append_rows_with_offset<'a, COL>( &mut self, columns: impl IntoIterator<Item = (&'a Identifier, COL)>, offset: usize, setup: &C::PublicSetup<'_>, ) -> Result<(), AppendColumnCommitmentsError>

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

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

The given generator offset will be used for committing to the new rows. You most likely want this to be equal to the 0-indexed row number of the first new row.

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

pub fn try_extend_columns_with_offset<'a, COL>( &mut self, columns: impl IntoIterator<Item = (&'a Identifier, COL)>, offset: usize, setup: &C::PublicSetup<'_>, ) -> Result<(), DuplicateIdentifiers>

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

Add new columns to this ColumnCommitments using the given generator offset.

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

where Self: Sized,

Add two ColumnCommitments together.

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

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

where Self: Sized,

Subtract two ColumnCommitments.

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

Trait Implementations

impl<C: Clone> Clone for ColumnCommitments<C>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug> Debug for ColumnCommitments<C>

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

Formats the value using the given formatter.

impl<C: Default> Default for ColumnCommitments<C>

fn default() -> ColumnCommitments<C>

Returns the “default value” for a type.

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

where C: 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> FromIterator<(Identifier, ColumnCommitmentMetadata, C)> for ColumnCommitments<C>

fn from_iter<T: IntoIterator<Item = (Identifier, ColumnCommitmentMetadata, C)>>( iter: T, ) -> Self

Creates a value from an iterator.

impl<'a, C> IntoIterator for &'a ColumnCommitments<C>

type Item = (&'a Identifier, &'a ColumnCommitmentMetadata, &'a C)

The type of the elements being iterated over.

type IntoIter = Map<Zip<<&'a IndexMap<Identifier, ColumnCommitmentMetadata, BuildHasherDefault<AHasher>> as IntoIterator>::IntoIter, Iter<'a, C>>, fn(_: ((&'a Identifier, &'a ColumnCommitmentMetadata), &'a C)) -> (&'a Identifier, &'a ColumnCommitmentMetadata, &'a C)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<C> IntoIterator for ColumnCommitments<C>

type Item = (Identifier, ColumnCommitmentMetadata, C)

The type of the elements being iterated over.

type IntoIter = Map<Zip<<IndexMap<Identifier, ColumnCommitmentMetadata, BuildHasherDefault<AHasher>> as IntoIterator>::IntoIter, IntoIter<C>>, fn(_: ((Identifier, ColumnCommitmentMetadata), C)) -> (Identifier, ColumnCommitmentMetadata, C)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<C: PartialEq> PartialEq for ColumnCommitments<C>

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

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

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 ColumnCommitments<C>

where C: 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> Eq for ColumnCommitments<C>

impl<C> StructuralPartialEq for ColumnCommitments<C>