Struct randomx4r::RandomxFlags

pub struct RandomxFlags { /* fields omitted */ }

Represents options that can be used when allocating the RandomX dataset or VM.

Methods

impl RandomxFlags

pub const DEFAULT: RandomxFlags

Use defaults.

pub const LARGEPAGES: RandomxFlags

Allocate memory in large pages.

pub const HARDAES: RandomxFlags

The RandomX VM will use hardware accelerated AES.

pub const FULLMEM: RandomxFlags

The RandomX VM will use the full dataset.

pub const JIT: RandomxFlags

The RandomX VM will use a JIT compiler.

pub const SECURE: RandomxFlags

Make sure that JIT pages are never writable and executable at the same time.

pub const ARGON2_SSSE3: RandomxFlags

Use the SSSE3 extension to speed up Argon2 operations.

pub const ARGON2_AVX2: RandomxFlags

Use the AVX2 extension to speed up Argon2 operations.

pub const ARGON2: RandomxFlags

Do not use SSSE3 or AVX2 extensions.

pub const fn empty() -> RandomxFlags

Returns an empty set of flags

pub const fn all() -> RandomxFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<RandomxFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> RandomxFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> RandomxFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: RandomxFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: RandomxFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: RandomxFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: RandomxFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: RandomxFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: RandomxFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for RandomxFlags

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

Formats the value using the given formatter.

impl BitAnd<RandomxFlags> for RandomxFlags

type Output = RandomxFlags

The resulting type after applying the & operator.

fn bitand(self, other: RandomxFlags) -> RandomxFlags

Returns the intersection between the two sets of flags.

impl BitAndAssign<RandomxFlags> for RandomxFlags

fn bitand_assign(&mut self, other: RandomxFlags)

Disables all flags disabled in the set.

impl BitOr<RandomxFlags> for RandomxFlags

type Output = RandomxFlags

The resulting type after applying the | operator.

fn bitor(self, other: RandomxFlags) -> RandomxFlags

Returns the union of the two sets of flags.

impl BitOrAssign<RandomxFlags> for RandomxFlags

fn bitor_assign(&mut self, other: RandomxFlags)

Adds the set of flags.

impl BitXor<RandomxFlags> for RandomxFlags

type Output = RandomxFlags

The resulting type after applying the ^ operator.

fn bitxor(self, other: RandomxFlags) -> RandomxFlags

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<RandomxFlags> for RandomxFlags

fn bitxor_assign(&mut self, other: RandomxFlags)

Toggles the set of flags.

impl Clone for RandomxFlags

fn clone(&self) -> RandomxFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RandomxFlags

impl Debug for RandomxFlags

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

Formats the value using the given formatter.

impl Default for RandomxFlags

fn default() -> RandomxFlags

Get the recommended flags to use on the current machine.

Does not include any of the following flags:

• LARGEPAGES
• JIT
• SECURE

impl Eq for RandomxFlags

impl Extend<RandomxFlags> for RandomxFlags

fn extend<T: IntoIterator<Item = RandomxFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl FromIterator<RandomxFlags> for RandomxFlags

fn from_iter<T: IntoIterator<Item = RandomxFlags>>(iterator: T) -> RandomxFlags

Creates a value from an iterator.

impl Hash for RandomxFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl LowerHex for RandomxFlags

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

Formats the value using the given formatter.

impl Not for RandomxFlags

type Output = RandomxFlags

The resulting type after applying the ! operator.

fn not(self) -> RandomxFlags

Returns the complement of this set of flags.

impl Octal for RandomxFlags

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

Formats the value using the given formatter.

impl Ord for RandomxFlags

fn cmp(&self, other: &RandomxFlags) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<RandomxFlags> for RandomxFlags

fn eq(&self, other: &RandomxFlags) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &RandomxFlags) -> bool

This method tests for !=.

impl PartialOrd<RandomxFlags> for RandomxFlags

fn partial_cmp(&self, other: &RandomxFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &RandomxFlags) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &RandomxFlags) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &RandomxFlags) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &RandomxFlags) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for RandomxFlags

impl StructuralPartialEq for RandomxFlags

impl Sub<RandomxFlags> for RandomxFlags

type Output = RandomxFlags

The resulting type after applying the - operator.

fn sub(self, other: RandomxFlags) -> RandomxFlags

Returns the set difference of the two sets of flags.

impl SubAssign<RandomxFlags> for RandomxFlags

fn sub_assign(&mut self, other: RandomxFlags)

Disables all flags enabled in the set.

impl UpperHex for RandomxFlags

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

Formats the value using the given formatter.