Struct OutputStore

pub struct OutputStore<N: Network, O: OutputStorage<N>> { /* private fields */ }

The transition output store.

Implementations

impl<N: Network, O: OutputStorage<N>> OutputStore<N, O>

pub fn open<S: Clone + Into<StorageMode>>(storage: S) -> Result<Self>

Initializes the transition output store.

pub fn from(storage: O) -> Self

Initializes a transition output store from storage.

pub fn insert( &self, transition_id: N::TransitionID, outputs: &[Output<N>], ) -> Result<()>

Stores the given (transition ID, output) pair into storage.

pub fn remove(&self, transition_id: &N::TransitionID) -> Result<()>

Removes the output for the given transition ID.

pub fn start_atomic(&self)

Starts an atomic batch write operation.

pub fn is_atomic_in_progress(&self) -> bool

Checks if an atomic batch is in progress.

pub fn atomic_checkpoint(&self)

Checkpoints the atomic batch.

pub fn clear_latest_checkpoint(&self)

Clears the latest atomic batch checkpoint.

pub fn atomic_rewind(&self)

Rewinds the atomic batch to the previous checkpoint.

pub fn abort_atomic(&self)

Aborts an atomic batch write operation.

pub fn finish_atomic(&self) -> Result<()>

Finishes an atomic batch write operation.

pub fn storage_mode(&self) -> &StorageMode

Returns the storage mode.

impl<N: Network, O: OutputStorage<N>> OutputStore<N, O>

pub fn get_output_ids( &self, transition_id: &N::TransitionID, ) -> Result<Vec<Field<N>>>

Returns the output IDs for the given transition ID.

pub fn get_outputs( &self, transition_id: &N::TransitionID, ) -> Result<Vec<Output<N>>>

Returns the outputs for the given transition ID.

pub fn get_record( &self, commitment: &Field<N>, ) -> Result<Option<Record<N, Ciphertext<N>>>>

Returns the record for the given commitment.

If the record exists, Ok(Some(record)) is returned. If the record was purged, Ok(None) is returned. If the record does not exist, Err(error) is returned.

impl<N: Network, O: OutputStorage<N>> OutputStore<N, O>

pub fn find_transition_id( &self, output_id: &Field<N>, ) -> Result<Option<N::TransitionID>>

Returns the transition ID that contains the given output ID.

impl<N: Network, O: OutputStorage<N>> OutputStore<N, O>

pub fn contains_output_id(&self, output_id: &Field<N>) -> Result<bool>

Returns true if the given output ID exists.

pub fn contains_commitment(&self, commitment: &Field<N>) -> Result<bool>

Returns true if the given commitment exists.

pub fn contains_checksum(&self, checksum: &Field<N>) -> bool

Returns true if the given checksum exists.

pub fn contains_nonce(&self, nonce: &Group<N>) -> Result<bool>

Returns true if the given nonce exists.

impl<N: Network, O: OutputStorage<N>> OutputStore<N, O>

pub fn output_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>

Returns an iterator over the output IDs, for all transition outputs.

pub fn constant_output_ids( &self, ) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>

Returns an iterator over the constant output IDs, for all transition outputs that are constant.

pub fn public_output_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>

Returns an iterator over the public output IDs, for all transition outputs that are public.

pub fn private_output_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>

Returns an iterator over the private output IDs, for all transition outputs that are private.

pub fn commitments(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>

Returns an iterator over the commitments, for all transition outputs that are records.

pub fn external_output_ids( &self, ) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>

Returns an iterator over the external record output IDs, for all transition outputs that are external records.

pub fn future_output_ids(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>

Returns an iterator over the future output IDs, for all transition outputs that are future outputs.

impl<N: Network, I: OutputStorage<N>> OutputStore<N, I>

pub fn constant_outputs( &self, ) -> impl '_ + Iterator<Item = Cow<'_, Plaintext<N>>>

Returns an iterator over the constant outputs, for all transitions.

pub fn public_outputs(&self) -> impl '_ + Iterator<Item = Cow<'_, Plaintext<N>>>

Returns an iterator over the constant outputs, for all transitions.

pub fn private_outputs( &self, ) -> impl '_ + Iterator<Item = Cow<'_, Ciphertext<N>>>

Returns an iterator over the private outputs, for all transitions.

pub fn checksums(&self) -> impl '_ + Iterator<Item = Cow<'_, Field<N>>>

Returns an iterator over the checksums, for all transition outputs that are records.

pub fn nonces(&self) -> impl '_ + Iterator<Item = Cow<'_, Group<N>>>

Returns an iterator over the nonces, for all transition outputs that are records.

pub fn records( &self, ) -> impl '_ + Iterator<Item = (Cow<'_, Field<N>>, Cow<'_, Record<N, Ciphertext<N>>>)>

Returns an iterator over the (commitment, record) pairs, for all transition outputs that are records.

pub fn future_outputs(&self) -> impl '_ + Iterator<Item = Cow<'_, Future<N>>>

Returns an iterator over the future outputs, for all transitions.

Trait Implementations

impl<N: Clone + Network, O: Clone + OutputStorage<N>> Clone for OutputStore<N, O>

where O::ConstantMap: Clone, O::PublicMap: Clone, O::PrivateMap: Clone, O::RecordMap: Clone, O::RecordNonceMap: Clone, O::ExternalRecordMap: Clone, O::FutureMap: Clone,

fn clone(&self) -> OutputStore<N, O>

Returns a copy of the value.

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

Performs copy-assignment from source.