OutputStore

Struct OutputStore 

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

The transition output store.

Implementations§

Source§

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

Source

pub fn open(dev: Option<u16>) -> Result<OutputStore<N, O>, Error>

Initializes the transition output store.

Source

pub fn from(storage: O) -> OutputStore<N, O>

Initializes a transition output store from storage.

Source

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

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

Source

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

Removes the output for the given transition ID.

Source

pub fn start_atomic(&self)

Starts an atomic batch write operation.

Source

pub fn is_atomic_in_progress(&self) -> bool

Checks if an atomic batch is in progress.

Source

pub fn atomic_checkpoint(&self)

Checkpoints the atomic batch.

Source

pub fn clear_latest_checkpoint(&self)

Clears the latest atomic batch checkpoint.

Source

pub fn atomic_rewind(&self)

Rewinds the atomic batch to the previous checkpoint.

Source

pub fn abort_atomic(&self)

Aborts an atomic batch write operation.

Source

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

Finishes an atomic batch write operation.

Source

pub fn dev(&self) -> Option<u16>

Returns the optional development ID.

Source§

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

Source

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

Returns the output IDs for the given transition ID.

Source

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

Returns the outputs for the given transition ID.

Source

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

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.

Source§

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

Source

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

Returns the transition ID that contains the given output ID.

Source§

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

Source

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

Returns true if the given output ID exists.

Source

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

Returns true if the given commitment exists.

Source

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

Returns true if the given checksum exists.

Source

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

Returns true if the given nonce exists.

Source§

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

Source

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

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

Source

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.

Source

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.

Source

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.

Source

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

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

Source

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.

Source

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.

Source§

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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.

Source

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

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

Trait Implementations§

Source§

impl<N, O> Clone for OutputStore<N, O>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<N, O> Freeze for OutputStore<N, O>

§

impl<N, O> RefUnwindSafe for OutputStore<N, O>

§

impl<N, O> Send for OutputStore<N, O>

§

impl<N, O> Sync for OutputStore<N, O>

§

impl<N, O> Unpin for OutputStore<N, O>

§

impl<N, O> UnwindSafe for OutputStore<N, O>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more