Struct randomx_rs::RandomXVM

pub struct RandomXVM { /* private fields */ }

The RandomX Virtual Machine (VM) is a complex instruction set computer that executes generated programs.

Implementations

impl RandomXVM

pub fn new( flags: RandomXFlag, cache: Option<RandomXCache>, dataset: Option<RandomXDataset> ) -> Result<RandomXVM, RandomXError>

Creates a new VM and initializes it, error on failure.

flags is any combination of the following 5 flags:

• FLAG_LARGE_PAGES
• FLAG_HARD_AES
• FLAG_FULL_MEM
• FLAG_JIT
• FLAG_SECURE

Or

• FLAG_DEFAULT

cache is a cache object, optional if FLAG_FULL_MEM is set.

dataset is a dataset object, optional if FLAG_FULL_MEM is not set.

pub fn reinit_cache(&mut self, cache: RandomXCache) -> Result<(), RandomXError>

Re-initializes the VM with a new cache that was initialised without RandomXFlag::FLAG_FULL_MEM.

pub fn reinit_dataset( &mut self, dataset: RandomXDataset ) -> Result<(), RandomXError>

Re-initializes the VM with a new dataset that was initialised with RandomXFlag::FLAG_FULL_MEM.

pub fn calculate_hash(&self, input: &[u8]) -> Result<Vec<u8>, RandomXError>

Calculates a RandomX hash value and returns it, error on failure.

input is a sequence of u8 to be hashed.

pub fn calculate_hash_set( &self, input: &[&[u8]] ) -> Result<Vec<Vec<u8>>, RandomXError>

Calculates hashes from a set of inputs.

input is an array of a sequence of u8 to be hashed.

Trait Implementations

impl Debug for RandomXVM

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

Formats the value using the given formatter.

impl Drop for RandomXVM

fn drop(&mut self)

De-allocates memory for the VM object.