Trait OutputStorage

pub trait OutputStorage<N: Network>:
    Clone
    + Send
    + Sync {
    type IDMap: for<'a> Map<'a, N::TransitionID, Vec<Field<N>>>;
    type ReverseIDMap: for<'a> Map<'a, Field<N>, N::TransitionID>;
    type ConstantMap: for<'a> Map<'a, Field<N>, Option<Plaintext<N>>>;
    type PublicMap: for<'a> Map<'a, Field<N>, Option<Plaintext<N>>>;
    type PrivateMap: for<'a> Map<'a, Field<N>, Option<Ciphertext<N>>>;
    type RecordMap: for<'a> Map<'a, Field<N>, (Field<N>, Option<Record<N, Ciphertext<N>>>)>;
    type RecordNonceMap: for<'a> Map<'a, Group<N>, Field<N>>;
    type ExternalRecordMap: for<'a> Map<'a, Field<N>, ()>;
    type FutureMap: for<'a> Map<'a, Field<N>, Option<Future<N>>>;

    // Required methods
    fn open<S: Clone + Into<StorageMode>>(storage: S) -> Result<Self>;
    fn id_map(&self) -> &Self::IDMap;
    fn reverse_id_map(&self) -> &Self::ReverseIDMap;
    fn constant_map(&self) -> &Self::ConstantMap;
    fn public_map(&self) -> &Self::PublicMap;
    fn private_map(&self) -> &Self::PrivateMap;
    fn record_map(&self) -> &Self::RecordMap;
    fn record_nonce_map(&self) -> &Self::RecordNonceMap;
    fn external_record_map(&self) -> &Self::ExternalRecordMap;
    fn future_map(&self) -> &Self::FutureMap;
    fn storage_mode(&self) -> &StorageMode;

    // Provided methods
    fn start_atomic(&self) { ... }
    fn is_atomic_in_progress(&self) -> bool { ... }
    fn atomic_checkpoint(&self) { ... }
    fn clear_latest_checkpoint(&self) { ... }
    fn atomic_rewind(&self) { ... }
    fn abort_atomic(&self) { ... }
    fn finish_atomic(&self) -> Result<()> { ... }
    fn insert(
        &self,
        transition_id: N::TransitionID,
        outputs: &[Output<N>],
    ) -> Result<()> { ... }
    fn remove(&self, transition_id: &N::TransitionID) -> Result<()> { ... }
    fn find_transition_id(
        &self,
        output_id: &Field<N>,
    ) -> Result<Option<N::TransitionID>> { ... }
    fn get_ids(&self, transition_id: &N::TransitionID) -> Result<Vec<Field<N>>> { ... }
    fn get(&self, transition_id: &N::TransitionID) -> Result<Vec<Output<N>>> { ... }
}

A trait for transition output storage.

Required Associated Types

type IDMap: for<'a> Map<'a, N::TransitionID, Vec<Field<N>>>

The mapping of transition ID to output IDs.

type ReverseIDMap: for<'a> Map<'a, Field<N>, N::TransitionID>

The mapping of output ID to transition ID.

type ConstantMap: for<'a> Map<'a, Field<N>, Option<Plaintext<N>>>

The mapping of plaintext hash to (optional) plaintext.

type PublicMap: for<'a> Map<'a, Field<N>, Option<Plaintext<N>>>

The mapping of plaintext hash to (optional) plaintext.

type PrivateMap: for<'a> Map<'a, Field<N>, Option<Ciphertext<N>>>

The mapping of ciphertext hash to (optional) ciphertext.

type RecordMap: for<'a> Map<'a, Field<N>, (Field<N>, Option<Record<N, Ciphertext<N>>>)>

The mapping of commitment to (checksum, (optional) record ciphertext).

type RecordNonceMap: for<'a> Map<'a, Group<N>, Field<N>>

The mapping of record nonce to commitment.

type ExternalRecordMap: for<'a> Map<'a, Field<N>, ()>

The mapping of external hash to (). Note: This is not the record commitment.

type FutureMap: for<'a> Map<'a, Field<N>, Option<Future<N>>>

The mapping of future hash to (optional) future.

Required Methods

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

Initializes the transition output storage.

fn id_map(&self) -> &Self::IDMap

Returns the ID map.

fn reverse_id_map(&self) -> &Self::ReverseIDMap

Returns the reverse ID map.

fn constant_map(&self) -> &Self::ConstantMap

Returns the constant map.

fn public_map(&self) -> &Self::PublicMap

Returns the public map.

fn private_map(&self) -> &Self::PrivateMap

Returns the private map.

fn record_map(&self) -> &Self::RecordMap

Returns the record map.

fn record_nonce_map(&self) -> &Self::RecordNonceMap

Returns the record nonce map.

fn external_record_map(&self) -> &Self::ExternalRecordMap

Returns the external record map.

fn future_map(&self) -> &Self::FutureMap

Returns the future map.

fn storage_mode(&self) -> &StorageMode

Returns the storage mode.

Provided Methods

fn start_atomic(&self)

Starts an atomic batch write operation.

fn is_atomic_in_progress(&self) -> bool

Checks if an atomic batch is in progress.

fn atomic_checkpoint(&self)

Checkpoints the atomic batch.

fn clear_latest_checkpoint(&self)

Clears the latest atomic batch checkpoint.

fn atomic_rewind(&self)

Rewinds the atomic batch to the previous checkpoint.

fn abort_atomic(&self)

Aborts an atomic batch write operation.

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

Finishes an atomic batch write operation.

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

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

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

Removes the output for the given transition ID.

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

Returns the transition ID that contains the given output ID.

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

Returns the output IDs for the given transition ID.

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

Returns the output for the given transition ID.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<N: Network> OutputStorage<N> for OutputMemory<N>

type IDMap = MemoryMap<<N as Network>::TransitionID, Vec<Field<N>>>

type ReverseIDMap = MemoryMap<Field<N>, <N as Network>::TransitionID>

type ConstantMap = MemoryMap<Field<N>, Option<Plaintext<N>>>

type PublicMap = MemoryMap<Field<N>, Option<Plaintext<N>>>

type PrivateMap = MemoryMap<Field<N>, Option<Ciphertext<N>>>

type RecordMap = MemoryMap<Field<N>, (Field<N>, Option<Record<N, Ciphertext<N>>>)>

type RecordNonceMap = MemoryMap<Group<N>, Field<N>>

type ExternalRecordMap = MemoryMap<Field<N>, ()>

type FutureMap = MemoryMap<Field<N>, Option<Future<N>>>