Struct rhai::FnCallHashes

pub struct FnCallHashes { /* private fields */ }

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

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

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 (if any) is tried, which contains only the called function’s name plus the number 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 complete native function call hash always contains the called function’s name plus the types of the arguments. This is due to possible function overloading for different parameter types.

Implementations

impl FnCallHashes

pub const fn from_hash(hash: u64) -> Self

Create a FnCallHashes from a single hash.

pub const fn from_native_only(hash: u64) -> Self

Create a FnCallHashes with only the native Rust hash.

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

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

Not available under no_function.

pub const fn is_native_only(&self) -> bool

Is this FnCallHashes native-only?

pub const fn native(&self) -> u64

Get the native hash.

The hash returned is never zero.

pub fn script(&self) -> u64

Get the script hash.

The hash returned is never zero.

Panics

Panics if this FnCallHashes is native-only.

Trait Implementations

impl Clone for FnCallHashes

fn clone(&self) -> FnCallHashes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FnCallHashes

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

Formats the value using the given formatter.

impl Hash for FnCallHashes

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for FnCallHashes

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for FnCallHashes

impl Eq for FnCallHashes

impl StructuralPartialEq for FnCallHashes