Enum Output

pub enum Output<N: Network> {
    Constant(Field<N>, Option<Plaintext<N>>),
    Public(Field<N>, Option<Plaintext<N>>),
    Private(Field<N>, Option<Ciphertext<N>>),
    Record(Field<N>, Field<N>, Option<Record<N, Ciphertext<N>>>),
    ExternalRecord(Field<N>),
    Future(Field<N>, Option<Future<N>>),
}

The transition output.

Variants

Constant(Field<N>, Option<Plaintext<N>>)

The plaintext hash and (optional) plaintext.

Public(Field<N>, Option<Plaintext<N>>)

The plaintext hash and (optional) plaintext.

Private(Field<N>, Option<Ciphertext<N>>)

The ciphertext hash and (optional) ciphertext.

Record(Field<N>, Field<N>, Option<Record<N, Ciphertext<N>>>)

The commitment, checksum, and (optional) record ciphertext.

ExternalRecord(Field<N>)

The output commitment of the external record. Note: This is not the record commitment.

Future(Field<N>, Option<Future<N>>)

The future hash and (optional) future.

Implementations

impl<N: Network> Output<N>

pub const fn variant(&self) -> u8

Returns the variant of the output.

pub const fn id(&self) -> &Field<N>

Returns the ID of the output.

pub fn to_transition_leaf(&self, index: u8) -> TransitionLeaf<N>

Returns the output as a transition leaf.

pub const fn record(&self) -> Option<(&Field<N>, &Record<N, Ciphertext<N>>)>

Returns the commitment and record, if the output is a record.

pub fn into_record(self) -> Option<(Field<N>, Record<N, Ciphertext<N>>)>

Consumes self and returns the commitment and record, if the output is a record.

pub const fn commitment(&self) -> Option<&Field<N>>

Returns the commitment, if the output is a record.

pub fn into_commitment(self) -> Option<Field<N>>

Returns the commitment, if the output is a record, and consumes self.

pub const fn nonce(&self) -> Option<&Group<N>>

Returns the nonce, if the output is a record.

pub fn into_nonce(self) -> Option<Group<N>>

Returns the nonce, if the output is a record, and consumes self.

pub const fn checksum(&self) -> Option<&Field<N>>

Returns the checksum, if the output is a record.

pub fn into_checksum(self) -> Option<Field<N>>

Returns the checksum, if the output is a record, and consumes self.

pub const fn future(&self) -> Option<&Future<N>>

Returns the future, if the output is a future.

pub fn verifier_inputs(&self) -> impl '_ + Iterator<Item = N::Field>

Returns the public verifier inputs for the proof.

pub fn verify( &self, function_id: Field<N>, tcm: &Field<N>, index: usize, ) -> bool

Returns true if the output is well-formed. If the optional value exists, this method checks that it hashes to the output ID.

Trait Implementations

impl<N: Clone + Network> Clone for Output<N>

fn clone(&self) -> Output<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Network> Debug for Output<N>

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

Prints the output as a JSON-string.

impl<'de, N: Network> Deserialize<'de> for Output<N>

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserializes the transition output from a string or bytes.

impl<N: Network> Display for Output<N>

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

Displays the output as a JSON-string.

impl<N: Network> FromBytes for Output<N>

fn read_le<R: Read>(reader: R) -> IoResult<Self>

Reads the output from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N: Network> FromStr for Output<N>

fn from_str(output: &str) -> Result<Self, Self::Err>

Initializes the output from a JSON-string.

type Err = Error

The associated error which can be returned from parsing.

impl<N: PartialEq + Network> PartialEq for Output<N>

fn eq(&self, other: &Output<N>) -> 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<N: Network> Serialize for Output<N>

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serializes the transition output into string or bytes.

impl<N: Network> ToBytes for Output<N>

fn write_le<W: Write>(&self, writer: W) -> IoResult<()>

Writes the output to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N: Eq + Network> Eq for Output<N>

impl<N: Network> StructuralPartialEq for Output<N>