Struct snarkvm_circuit::Record

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

Implementations

impl<A> Record<A, Ciphertext<A>>where
    A: Aleo,

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

Decrypts self into a plaintext record using the given view key & nonce.

pub fn decrypt_symmetric(
    &self,
    record_view_key: Field<A>
) -> Record<A, Plaintext<A>>

Decrypts self into a plaintext record using the given record view key.

impl<A> Record<A, Plaintext<A>>where
    A: Aleo,

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

Encrypts self for the record owner under the given randomizer.

pub fn encrypt_symmetric(
    &self,
    record_view_key: Field<A>
) -> Record<A, Ciphertext<A>>

Encrypts self under the given record view key.

impl<A> Record<A, Plaintext<A>>where
    A: Aleo,

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

Returns the entry from the given path.

impl<A, Private> Record<A, Private>where
    A: Aleo,
    Private: Visibility<A>,

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

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

pub fn serial_number_from_gamma(
    gamma: &Group<A>,
    commitment: Field<A>
) -> Field<A>

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

impl<A, Private> Record<A, Private>where
    A: Aleo,
    Private: Visibility<A>,

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

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

impl<A> Record<A, Plaintext<A>>where
    A: Aleo,

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

Returns the record commitment.

impl<A> Record<A, Ciphertext<A>>where
    A: Aleo,

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

Returns the record commitment.

impl<A, Private> Record<A, Private>where
    A: Aleo,
    Private: Visibility<A>,

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

Initializes a new record plaintext.

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

Initializes a new record ciphertext.

impl<A, Private> Record<A, Private>where
    A: Aleo,
    Private: Visibility<A>,

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

Returns the owner of the program record.

pub const fn gates(&self) -> &Balance<A, Private>

Returns the gates of the program record.

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

Returns the program data.

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

Returns the nonce of the program record.

Trait Implementations

impl<A, Private> Clone for Record<A, Private>where
    A: Clone + Aleo,
    Private: Clone + Visibility<A>,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A> Eject for Record<A, Ciphertext<A>>where
    A: Aleo,

fn eject_mode(&self) -> Mode

Ejects the mode of the record.

fn eject_value(&self) -> <Record<A, Ciphertext<A>> as Eject>::Primitive

Ejects the record.

type Primitive = Record<<A as Environment>::Network, Ciphertext<<A as Environment>::Network>>

fn eject(&self) -> (Mode, Self::Primitive)

Ejects the mode and primitive value of the circuit type.

fn is_constant(&self) -> bool

Returns true if the circuit is a constant.

fn is_public(&self) -> bool

Returns true if the circuit is a public.

fn is_private(&self) -> bool

Returns true if the circuit is a private.

impl<A> Eject for Record<A, Plaintext<A>>where
    A: Aleo,

fn eject_mode(&self) -> Mode

Ejects the mode of the record.

fn eject_value(&self) -> <Record<A, Plaintext<A>> as Eject>::Primitive

Ejects the record.

type Primitive = Record<<A as Environment>::Network, Plaintext<<A as Environment>::Network>>

fn eject(&self) -> (Mode, Self::Primitive)

Ejects the mode and primitive value of the circuit type.

fn is_constant(&self) -> bool

Returns true if the circuit is a constant.

fn is_public(&self) -> bool

Returns true if the circuit is a public.

fn is_private(&self) -> bool

Returns true if the circuit is a private.

impl<A, Private> Equal<Record<A, Private>> for Record<A, Private>where
    A: Aleo,
    Private: Visibility<A>,

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

Returns true if self and other are equal.

Note: This method does not check the nonce equality.

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

Returns true if self and other are not equal.

Note: This method does not check the nonce equality.

type Output = Boolean<A>

impl<A> Inject for Record<A, Ciphertext<A>>where
    A: Aleo,

fn new(
    _: Mode,
    record: <Record<A, Ciphertext<A>> as Inject>::Primitive
) -> Record<A, Ciphertext<A>>

Initializes a ciphertext record from a primitive.

type Primitive = Record<<A as Environment>::Network, Ciphertext<<A as Environment>::Network>>

fn constant(value: Self::Primitive) -> Selfwhere
    Self: Sized,

Initializes a constant of the given primitive value.

impl<A> Inject for Record<A, Plaintext<A>>where
    A: Aleo,

fn new(
    _: Mode,
    record: <Record<A, Plaintext<A>> as Inject>::Primitive
) -> Record<A, Plaintext<A>>

Initializes a plaintext record from a primitive.

type Primitive = Record<<A as Environment>::Network, Plaintext<<A as Environment>::Network>>

fn constant(value: Self::Primitive) -> Selfwhere
    Self: Sized,

Initializes a constant of the given primitive value.

impl<A> ToBits for Record<A, Ciphertext<A>>where
    A: Aleo,

fn to_bits_le(
    &self
) -> Vec<<Record<A, Ciphertext<A>> as ToBits>::Boolean, Global>

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

fn to_bits_be(
    &self
) -> Vec<<Record<A, Ciphertext<A>> as ToBits>::Boolean, Global>

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

type Boolean = Boolean<A>

impl<A> ToBits for Record<A, Plaintext<A>>where
    A: Aleo,

fn to_bits_le(
    &self
) -> Vec<<Record<A, Plaintext<A>> as ToBits>::Boolean, Global>

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

fn to_bits_be(
    &self
) -> Vec<<Record<A, Plaintext<A>> as ToBits>::Boolean, Global>

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

type Boolean = Boolean<A>

impl<A> ToFields for Record<A, Ciphertext<A>>where
    A: Aleo,

fn to_fields(
    &self
) -> Vec<<Record<A, Ciphertext<A>> as ToFields>::Field, Global>

Returns this record as a list of field elements.

type Field = Field<A>

impl<A> ToFields for Record<A, Plaintext<A>>where
    A: Aleo,

fn to_fields(&self) -> Vec<<Record<A, Plaintext<A>> as ToFields>::Field, Global>

Returns this record as a list of field elements.

type Field = Field<A>

impl<A, Private> TypeName for Record<A, Private>where
    A: Aleo,
    Private: Visibility<A>,

fn type_name() -> &'static str

Returns the type name of the object as a string. (i.e. “u8”)