Struct rhai::FnCallHash

pub struct FnCallHash {
    pub script: Option<u64>,
    pub native: u64,
}

(INTERNALS) An set of function call hashes. Exported under the internals feature only.

Two separate hashes are pre-calculated because of the following pattern:

func(a, b, c);      // Native: func(a, b, c) - 3 parameters
                    // Script: func(a, b, c) - 3 parameters

a.func(b, c);       // Native: func(&mut a, b, c) - 3 parameters
                    // Script: func(b, c) - 2 parameters

For normal function calls, the native hash equals the script hash. For method-style calls, the script hash contains one fewer parameter.

Function call hashes are used in the following manner:

• First, the script hash is tried, which contains only the called function’s name plus the of parameters.

• Next, the actual types of arguments are hashed and combined with the native hash, which is then used to search for a native function. In other words, a native function call hash always contains the called function’s name plus the types of the arguments. This is to due to possible function overloading for different parameter types.

Volatile Data Structure

This type is volatile and may change.

Fields

script: Option<u64>

Pre-calculated hash for a script-defined function (None if native functions only).

native: u64

Pre-calculated hash for a native Rust function with no parameter types.

Implementations

impl FnCallHash

pub fn from_native(hash: u64) -> Self

Create a FnCallHash with only the native Rust hash.

pub fn from_script(hash: u64) -> Self

Create a FnCallHash with both native Rust and script function hashes set to the same value.

pub fn from_script_and_native(script: u64, native: u64) -> Self

Create a FnCallHash with both native Rust and script function hashes.

pub fn is_native_only(&self) -> bool

Is this FnCallHash native Rust only?

pub fn script_hash(&self) -> u64

Get the script function hash from this FnCallHash.

Panics

Panics if the FnCallHash is native Rust only.

pub fn native_hash(&self) -> u64

Get the naive Rust function hash from this FnCallHash.

Trait Implementations

impl Clone for FnCallHash

fn clone(&self) -> FnCallHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for FnCallHash

impl Debug for FnCallHash

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

Formats the value using the given formatter.

impl Default for FnCallHash

fn default() -> FnCallHash

Returns the “default value” for a type.

impl Eq for FnCallHash

impl Hash for FnCallHash

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<FnCallHash> for FnCallHash

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

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

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

This method tests for !=.

impl StructuralEq for FnCallHash

impl StructuralPartialEq for FnCallHash