Struct Record 

pub struct Record<N, Private>
where
    N: Network,
    Private: Visibility,
{ /* private fields */ }

A value stored in program record.

Implementations

impl<N> Record<N, Ciphertext<N>>

where N: Network,

pub fn decrypt( &self, view_key: &ViewKey<N>, ) -> Result<Record<N, Plaintext<N>>, Error>

Decrypts self into plaintext using the given view key and checks that the owner matches the view key.

pub fn decrypt_symmetric_unchecked( &self, record_view_key: &Field<N>, ) -> Result<Record<N, Plaintext<N>>, Error>

Decrypts self into plaintext using the given record view key. Note: This method does not check that the record view key corresponds to the record owner. Use Self::decrypt for the checked variant.

impl<N> Record<N, Plaintext<N>>

where N: Network,

pub fn encrypt( &self, randomizer: Scalar<N>, ) -> Result<Record<N, Ciphertext<N>>, Error>

Encrypts self for the record owner under the given randomizer.

pub fn encrypt_symmetric_unchecked( &self, record_view_key: &Field<N>, ) -> Result<Record<N, Ciphertext<N>>, Error>

Encrypts self under the given record view key. Note: This method does not check that the record view key corresponds to the record owner. Use Self::encrypt for the checked variant.

impl<N> Record<N, Plaintext<N>>

where N: Network,

pub fn find<A>(&self, path: &[A]) -> Result<Entry<N, Plaintext<N>>, Error>

where A: Into<Access<N>> + Copy + Debug,

Returns the entry from the given path.

impl<N> Record<N, Ciphertext<N>>

where N: Network,

pub fn is_owner(&self, view_key: &ViewKey<N>) -> bool

Decrypts self into plaintext using the given view key.

pub fn is_owner_with_address_x_coordinate( &self, view_key: &ViewKey<N>, address_x_coordinate: &Field<N>, ) -> bool

Decrypts self into plaintext using the x-coordinate of the address corresponding to the given view key.

impl<N, Private> Record<N, Private>

where N: Network, Private: Visibility,

pub fn serial_number( private_key: PrivateKey<N>, commitment: Field<N>, ) -> Result<Field<N>, Error>

A helper method to derive the serial number from the private key and commitment.

pub fn serial_number_from_gamma( gamma: &Group<N>, commitment: Field<N>, ) -> Result<Field<N>, Error>

A helper method to derive the serial number from the gamma and commitment.

impl<N, Private> Record<N, Private>

where N: Network, Private: Visibility,

pub fn tag(sk_tag: Field<N>, commitment: Field<N>) -> Result<Field<N>, Error>

A helper method to derive the tag from the sk_tag and commitment.

impl<N> Record<N, Plaintext<N>>

where N: Network,

pub fn to_commitment( &self, program_id: &ProgramID<N>, record_name: &Identifier<N>, ) -> Result<Field<N>, Error>

Returns the record commitment.

impl<N> Record<N, Ciphertext<N>>

where N: Network,

pub fn to_commitment( &self, _program_id: &ProgramID<N>, _record_name: &Identifier<N>, ) -> Result<Field<N>, Error>

Returns the record commitment.

impl<N, Private> Record<N, Private>

where N: Network, Private: Visibility,

pub fn from_plaintext( owner: Owner<N, Plaintext<N>>, data: IndexMap<Identifier<N>, Entry<N, Plaintext<N>>>, nonce: Group<N>, ) -> Result<Record<N, Plaintext<N>>, Error>

Initializes a new record plaintext.

pub fn from_ciphertext( owner: Owner<N, Ciphertext<N>>, data: IndexMap<Identifier<N>, Entry<N, Ciphertext<N>>>, nonce: Group<N>, ) -> Result<Record<N, Ciphertext<N>>, Error>

Initializes a new record ciphertext.

impl<N, Private> Record<N, Private>

where N: Network, Private: Visibility,

pub const fn owner(&self) -> &Owner<N, Private>

Returns the owner of the program record.

pub const fn data(&self) -> &IndexMap<Identifier<N>, Entry<N, Private>>

Returns the program data.

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

Returns the nonce of the program record.

impl<N, Private> Record<N, Private>

where N: Network, Private: Visibility,

pub fn into_owner(self) -> Owner<N, Private>

Returns the owner of the program record, and consumes self.

pub fn into_data(self) -> IndexMap<Identifier<N>, Entry<N, Private>>

Returns the program data, and consumes self.

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

Returns the nonce of the program record, and consumes self.

Trait Implementations

impl<N, Private> Clone for Record<N, Private>

where N: Clone + Network, Private: Clone + Visibility,

fn clone(&self) -> Record<N, Private>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for Record<N, Ciphertext<N>>

where N: Network,

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

Formats the value using the given formatter.

impl<N> Debug for Record<N, Plaintext<N>>

where N: Network,

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

Prints the record as a string.

impl<'de, N> Deserialize<'de> for Record<N, Ciphertext<N>>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<Record<N, Ciphertext<N>>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the record ciphertext from a string or bytes.

impl<'de, N> Deserialize<'de> for Record<N, Plaintext<N>>

where N: Network,

fn deserialize<D>( deserializer: D, ) -> Result<Record<N, Plaintext<N>>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserializes the record plaintext from a string or bytes.

impl<N> Display for Record<N, Ciphertext<N>>

where N: Network,

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

Writes the record ciphertext as a bech32m string.

impl<N> Display for Record<N, Plaintext<N>>

where N: Network,

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

Prints the record as a string.

impl<N, Private> Equal for Record<N, Private>

where N: Network, Private: Visibility<Boolean = Boolean<N>>,

fn is_equal( &self, other: &Record<N, Private>, ) -> <Record<N, Private> as Equal>::Output

Returns true if self and other are equal.

fn is_not_equal( &self, other: &Record<N, Private>, ) -> <Record<N, Private> as Equal>::Output

Returns true if self and other are not equal.

type Output = Boolean<N>

impl<N> From<&Record<N, Plaintext<N>>> for Value<N>

where N: Network,

fn from(record: &Record<N, Plaintext<N>>) -> Value<N>

Initializes the value from a record.

impl<N> From<Record<N, Plaintext<N>>> for Value<N>

where N: Network,

fn from(record: Record<N, Plaintext<N>>) -> Value<N>

Initializes the value from a record.

impl<N, Private> FromBytes for Record<N, Private>

where N: Network, Private: Visibility,

fn read_le<R>(reader: R) -> Result<Record<N, Private>, Error>

where R: Read,

Reads the record 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> FromStr for Record<N, Ciphertext<N>>

where N: Network,

fn from_str( ciphertext: &str, ) -> Result<Record<N, Ciphertext<N>>, <Record<N, Ciphertext<N>> as FromStr>::Err>

Reads in the ciphertext string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> FromStr for Record<N, Plaintext<N>>

where N: Network,

fn from_str(string: &str) -> Result<Record<N, Plaintext<N>>, Error>

Returns a record from a string literal.

type Err = Error

The associated error which can be returned from parsing.

impl<N> Parser for Record<N, Ciphertext<N>>

where N: Network,

fn parse( string: &str, ) -> Result<(&str, Record<N, Ciphertext<N>>), Err<VerboseError<&str>>>

Parses a string into an ciphertext.

impl<N> Parser for Record<N, Plaintext<N>>

where N: Network,

fn parse( string: &str, ) -> Result<(&str, Record<N, Plaintext<N>>), Err<VerboseError<&str>>>

Parses a string as a record: { owner: address, identifier_0: entry_0, ..., identifier_n: entry_n, _nonce: field }.

impl<N, Private> PartialEq for Record<N, Private>

where N: Network, Private: Visibility<Boolean = Boolean<N>>,

fn eq(&self, other: &Record<N, Private>) -> bool

Returns true if self and other are equal.

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> Serialize for Record<N, Ciphertext<N>>

where N: Network,

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

where S: Serializer,

Serializes the record ciphertext into a string or as bytes.

impl<N> Serialize for Record<N, Plaintext<N>>

where N: Network,

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

where S: Serializer,

Serializes the record plaintext into a string or as bytes.

impl<N> ToBits for Record<N, Ciphertext<N>>

where N: Network,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns this data as a list of little-endian bits.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns this data as a list of big-endian bits.

fn to_bits_le(&self) -> Vec<bool>

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

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N> ToBits for Record<N, Plaintext<N>>

where N: Network,

fn write_bits_le(&self, vec: &mut Vec<bool>)

Returns this data as a list of little-endian bits.

fn write_bits_be(&self, vec: &mut Vec<bool>)

Returns this data as a list of big-endian bits.

fn to_bits_le(&self) -> Vec<bool>

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

fn to_bits_be(&self) -> Vec<bool>

Returns self as a boolean array in big-endian order.

fn num_bits() -> Option<usize>

An optional indication of how many bits an object can be represented with.

impl<N, Private> ToBytes for Record<N, Private>

where N: Network, Private: Visibility,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes the record 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> ToFields for Record<N, Ciphertext<N>>

where N: Network,

fn to_fields( &self, ) -> Result<Vec<<Record<N, Ciphertext<N>> as ToFields>::Field>, Error>

Returns this record as a list of field elements.

type Field = Field<N>

impl<N> ToFields for Record<N, Plaintext<N>>

where N: Network,

fn to_fields( &self, ) -> Result<Vec<<Record<N, Plaintext<N>> as ToFields>::Field>, Error>

Returns this record as a list of field elements.

type Field = Field<N>

impl<N, Private> Eq for Record<N, Private>

where N: Network, Private: Visibility<Boolean = Boolean<N>>,