Struct ipworksencrypt::EzRand

Properties   Methods   Events   Config Settings   Errors  

The EzRand struct can be used to generate random numbers or bytes using a variety of algorithms.

Syntax

ipworksencrypt::EzRand

Remarks

The EzRand struct can be used to generate random numbers or bytes using a variety of algorithms and implementations.

To begin first set the algorithm property to the desired value. This property specifies the algorithm and implementation that will be used to generate the number or bytes. Possible choices include ISAAC, the Microsoft Crypto API, and platform specific random and secure random implementations.

Next set min and max to define the acceptable range of values when generating an integer. The seed property may optionally be set. Then simply call get_next_int to generate a random number. the rand_int property will be populated with the generated value.

To generate a random set of bytes set rand_bytes_length to the desired number of bytes and call get_next_bytes.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the EzRand struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of EzRand when you have finished using the instance.

Property List

---

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

algorithm property (EzRand Struct)

The random number algorithm.

Syntax

fn algorithm(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_algorithm(&self, value : i32) ->  Option<IPWorksEncryptError> 

Possible Values

0   // ISAAC
1   // MSCryptoAPI
2   // Platform
3   // SecurePlatform
4   // RC4Random

Default Value

0

Remarks

This property specifies the algorithm used to generate the random number or bytes. Possible values are:

Data Type

i32

max property (EzRand Struct)

The exclusive upper bound.

Syntax

fn max(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_max(&self, value : i32) ->  Option<IPWorksEncryptError> 

Default Value

100

Remarks

This property specifies the exclusive upper bound of the random integer to be generated. The value must be greater than min. The default value is 100.

Data Type

i32

min property (EzRand Struct)

The inclusive lower bound.

Syntax

fn min(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_min(&self, value : i32) ->  Option<IPWorksEncryptError> 

Default Value

0

Remarks

This property specifies the inclusive lower bound of the random integer to be generated. The value must be less than max, and must not be negative. The default value is 0.

Data Type

i32

rand_bytes property (EzRand Struct)

The random byte array.

Syntax

fn rand_bytes(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 

Default Value

""

Remarks

This property holds the random byte array generated by calling get_next_bytes.

This property is read-only.

Data Type

Vec

rand_bytes_length property (EzRand Struct)

The length of the byte array to be generated.

Syntax

fn rand_bytes_length(&self ) -> Result<i32, IPWorksEncryptError> 
fn set_rand_bytes_length(&self, value : i32) ->  Option<IPWorksEncryptError> 

Default Value

16

Remarks

This property specifies the length of the random byte array to be generated. The rand_bytes property will hold the byte array after get_next_bytes is called. The default value is 16.

Data Type

i32

rand_int property (EzRand Struct)

The random integer.

Syntax

fn rand_int(&self ) -> Result<i32, IPWorksEncryptError> 

Default Value

0

Remarks

This property holds the random integer generated by calling get_next_int.

This property is read-only.

Data Type

i32

seed property (EzRand Struct)

The seed.

Syntax

fn seed(&self ) -> Result<Vec<u8>, IPWorksEncryptError> 
fn set_seed(&self, value : Vec<u8>) ->  Option<IPWorksEncryptError> 
fn set_seed_ref(&self, value : &[u8]) ->  Option<IPWorksEncryptError> 

Default Value

""

Remarks

This property specifies the seed. This value is optional. If not specified and a seed is required the struct will use the current time.

Seed Notes

• When algorithm is set to 0 (raISAAC) the struct uses the leftmost 256 bytes.
• When algorithm is set to 1 (raMSCryptoAPI) the seed is ignored.
• When algorithm is set to 2 (raPlatform) the struct uses the leftmost 4 bytes.
• When algorithm is set to 3 (raSecurePlatform) in .NET the seed is ignored. The seed is applicable in Java.

Data Type

Vec

config method (EzRand Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEncryptError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

get_next_bytes method (EzRand Struct)

Generates a sequence of random bytes.

Syntax

fn get_next_bytes(&self) -> Result<(), IPWorksEncryptError>

Remarks

This method generates a new sequence of random bytes. The rand_bytes_length property specifies the length of the byte array. After calling this method the rand_bytes will hold the random bytes. The following properties are applicable when calling this method:

• algorithm
• rand_bytes_length
• seed

get_next_int method (EzRand Struct)

Generates a random integer.

Syntax

fn get_next_int(&self) -> Result<(), IPWorksEncryptError>

Remarks

This method generates a random integer. The min and max properties define the minimum and maximum values. After calling this method the rand_int property will hold the integer. The following properties are applicable when calling this method:

• algorithm
• min
• max
• seed

reset method (EzRand Struct)

Resets the struct.

Syntax

fn reset(&self) -> Result<(), IPWorksEncryptError>

Remarks

When called, the struct will reset all of its properties to their default values.

on_error event (EzRand Struct)

Fired when information is available about errors during data delivery.

Syntax

// EzRandErrorEventArgs carries the EzRand Error event's parameters.
pub struct EzRandErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// EzRandErrorEvent defines the signature of the EzRand Error event's handler function.
pub trait EzRandErrorEvent {
  fn on_error(&self, sender : EzRand, e : &mut EzRandErrorEventArgs);
}

impl <'a> EzRand<'a> {
  pub fn on_error(&self) -> &'a dyn EzRandErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn EzRandErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Config Settings (EzRand Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

EzRand Config Settings

Base Config Settings

Trappable Errors (EzRand Struct)

EzRand Errors