Struct Record

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

A value stored in program record.

Implementations

impl<N: Network> Record<N, Ciphertext<N>>

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

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>>>

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: Network> Record<N, Plaintext<N>>

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

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>>>

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: Network> Record<N, Plaintext<N>>

pub fn find<A: Into<Access<N>> + Copy + Debug>( &self, path: &[A], ) -> Result<Entry<N, Plaintext<N>>>

Returns the entry from the given path.

impl<N: Network> Record<N, Ciphertext<N>>

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

Returns true if the given view key corresponds to the owner of the record. 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

Returns true if the given view key and address x-coordinate corresponds to the owner of the record. Decrypts self into plaintext using the x-coordinate of the address corresponding to the given view key.

impl<N: Network, Private: Visibility> Record<N, Private>

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

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>>

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

impl<N: Network, Private: Visibility> Record<N, Private>

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

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

impl<N: Network> Record<N, Plaintext<N>>

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

Returns the record commitment.

impl<N: Network> Record<N, Ciphertext<N>>

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

Returns the record commitment.

impl<N: Network, Private: Visibility> Record<N, Private>

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>>>

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>>>

Initializes a new record ciphertext.

impl<N: Network, Private: Visibility> Record<N, Private>

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: Network, Private: Visibility> Record<N, Private>

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: Clone + Network, Private: Clone + Visibility> Clone for Record<N, Private>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Prints the record as a string.

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

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

Deserializes the record ciphertext from a string or bytes.

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

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

Deserializes the record plaintext from a string or bytes.

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

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

Writes the record ciphertext as a bech32m string.

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

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

Prints the record as a string.

impl<N: Network, Private: Visibility<Boolean = Boolean<N>>> Equal for Record<N, Private>

fn is_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are equal.

fn is_not_equal(&self, other: &Self) -> Self::Output

Returns true if self and other are not equal.

type Output = Boolean<N>

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

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

Initializes the value from a record.

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

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

Initializes the value from a record.

impl<N: Network, Private: Visibility> FromBytes for Record<N, Private>

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

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: Network> FromStr for Record<N, Ciphertext<N>>

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

Reads in the ciphertext string.

type Err = Error

The associated error which can be returned from parsing.

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

fn from_str(string: &str) -> Result<Self>

Returns a record from a string literal.

type Err = Error

The associated error which can be returned from parsing.

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

fn parse(string: &str) -> ParserResult<'_, Self>

Parses a string into an ciphertext.

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

fn parse(string: &str) -> ParserResult<'_, Self>

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

impl<N: Network, Private: Visibility<Boolean = Boolean<N>>> PartialEq for Record<N, Private>

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

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

Serializes the record ciphertext into a string or as bytes.

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

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

Serializes the record plaintext into a string or as bytes.

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

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: Network> ToBits for Record<N, Plaintext<N>>

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: Network, Private: Visibility> ToBytes for Record<N, Private>

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

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: Network> ToFields for Record<N, Ciphertext<N>>

fn to_fields(&self) -> Result<Vec<Self::Field>>

Returns this record as a list of field elements.

type Field = Field<N>

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

fn to_fields(&self) -> Result<Vec<Self::Field>>

Returns this record as a list of field elements.

type Field = Field<N>

impl<N: Network, Private: Visibility<Boolean = Boolean<N>>> Eq for Record<N, Private>