Struct Hash 

pub struct Hash(/* private fields */);

The primitive hash that among other things is used to reference items, types, and native functions.

Examples

use rune::Hash;

assert_ne!(Hash::index(0), Hash::index(1));

Implementations

impl Hash

pub const EMPTY: Hash

The empty hash.

Examples

use rune::Hash;

assert_ne!(Hash::index(0), Hash::EMPTY);
assert!(Hash::EMPTY.as_non_empty().is_none());

pub fn as_non_empty(&self) -> Option<NonZeroHash>

Return the current hash if it is non-empty.

Examples

use rune::Hash;

assert!(Hash::index(0).as_non_empty().is_some());
assert!(Hash::EMPTY.as_non_empty().is_none());

pub fn index(index: usize) -> Hash

Construct a hash from an index.

Examples

use rune::Hash;

assert_ne!(Hash::index(0), Hash::index(1));

pub fn ident(name: &str) -> Hash

Get the hash corresponding to a string identifier like function or hello_world.

Examples

use rune::Hash;

assert_ne!(Hash::ident("foo"), Hash::index(0));

pub fn type_hash(path: impl ToTypeHash) -> Hash

Get the hash of a type.

Examples

use rune::Hash;

assert!(!Hash::type_hash(["main"]).is_empty());
assert!(!Hash::type_hash(["main", "other"]).is_empty());

pub fn associated_function( type_hash: impl IntoHash, name: impl IntoHash, ) -> Hash

Construct a hash to an instance function, where the instance is a pre-determined type.

Examples

use rune::Hash;
use rune::runtime::Protocol;

assert!(!Hash::associated_function("main", &Protocol::INTO_TYPE_NAME).is_empty());

pub fn field_function( protocol: impl IntoHash, type_hash: Hash, name: impl IntoHash, ) -> Hash

Construct a hash corresponding to a field function.

Examples

use rune::{Hash, TypeHash};
use rune::runtime::Protocol;

assert!(!Hash::field_function(&Protocol::ADD, i64::HASH, "field").is_empty());

pub fn index_function( protocol: impl IntoHash, type_hash: Hash, index: Hash, ) -> Hash

Construct an index function.

Examples

use rune::{Hash, TypeHash};
use rune::runtime::Protocol;

assert!(!Hash::index_function(&Protocol::ADD, i64::HASH, Hash::index(1)).is_empty());

pub fn static_bytes(bytes: &[u8]) -> Hash

Get the hash corresponding to a static byte array.

pub fn object_keys<I>(keys: I) -> Hash

where I: IntoIterator, <I as IntoIterator>::Item: AsRef<str>,

Hash the given iterator of object keys.

pub const fn with_generics(self, generics: Hash) -> Hash

Mix in generics hash.

The generics hash must be a combination of the output from with_type_parameters and with_function_parameters.

pub const fn with_type_parameters(self, ty: Hash) -> Hash

Mix the current hash with type parameters.

pub const fn with_function_parameters(self, f: Hash) -> Hash

Mix the current hash with function parameters.

pub const fn parameters<const N: usize>(params: [Hash; N]) -> Hash

Hash type parameters.

Trait Implementations

impl Clone for Hash

fn clone(&self) -> Hash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hash

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

Formats the value using the given formatter.

impl<'__de, __A> Decode<'__de, Binary, __A> for Hash

where __A: Allocator,

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Hash, <T0 as Decoder<'__de>>::Error>

where T0: Decoder<'__de, Mode = Binary, Allocator = __A>,

Decode the current value.

impl<'__de, __A> Decode<'__de, Text, __A> for Hash

where __A: Allocator,

const IS_BITWISE_DECODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

fn decode<T0>(_1: T0) -> Result<Hash, <T0 as Decoder<'__de>>::Error>

where T0: Decoder<'__de, Mode = Text, Allocator = __A>,

Decode the current value.

impl Default for Hash

fn default() -> Hash

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Hash

fn deserialize<__D>( __deserializer: __D, ) -> Result<Hash, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Hash

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

Formats the value using the given formatter.

impl Encode<Binary> for Hash

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = Hash

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Binary>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &<Hash as Encode<Binary>>::Encode

Coerce into the underlying value being encoded.

impl Encode<Text> for Hash

const IS_BITWISE_ENCODE: bool = false

Whether the type is packed. Packed types can be bitwise copied if the representation of the serialization format is identical to the memory layout of the type.

type Encode = Hash

The underlying type being encoded.

fn encode<T0>(&self, _0: T0) -> Result<(), <T0 as Encoder>::Error>

where T0: Encoder<Mode = Text>,

Encode the given output.

fn size_hint(&self) -> Option<usize>

The number of fields in the type.

fn as_encode(&self) -> &<Hash as Encode<Text>>::Encode

Coerce into the underlying value being encoded.

impl From<Hash> for ConstValue

fn from(value: Hash) -> Self

Converts to this type from the input type.

impl From<Hash> for Value

fn from(value: Hash) -> Self

Converts to this type from the input type.

impl FromValue for Hash

fn from_value(value: Value) -> Result<Self, RuntimeError>

Try to convert to the given type, from the given value.

impl Hash for Hash

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

where __H: Hasher,

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 InstallWith for Hash

fn install_with(_: &mut Module) -> Result<(), ContextError>

Hook to install more things into the module.

impl IntoHash for Hash

fn into_hash(self) -> Hash

Convert current type into a hash.

impl MaybeTypeOf for Hash

fn maybe_type_of() -> Result<DocType>

Type information for the given type.

impl Named for Hash

const ITEM: &'static Item

The name item.

fn full_name(f: &mut Formatter<'_>) -> Result

The full name of the type.

fn display() -> impl Display

Return a display wrapper for the full name of the type.

impl Ord for Hash

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<Hash> for NonZeroHash

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq<NonZeroHash> for Hash

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Hash

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Hash

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Hash

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToConstValue for Hash

fn to_const_value(self) -> Result<ConstValue, RuntimeError>

Convert into a constant value.

impl ToValue for Hash

fn to_value(self) -> Result<Value, RuntimeError>

Convert into a value.

impl TryClone for Hash

fn try_clone(&self) -> Result<Hash, Error>

Try to clone the current value, raising an allocation error if it’s unsuccessful.

fn try_clone_from(&mut self, source: &Self) -> Result<(), Error>

Performs copy-assignment from source.

impl TypeHash for Hash

const HASH: Hash

The complete type hash of the type including type parameters which uniquely identifiers a given type.

impl TypeOf for Hash

const STATIC_TYPE_INFO: AnyTypeInfo

Access diagnostical type information for the current type.

const PARAMETERS: Hash = Hash::EMPTY

Type parameters for the type.

fn type_info() -> TypeInfo

Get type info associated with the current type.

impl Copy for Hash

impl Eq for Hash

impl IntoOutput for Hash

impl StructuralPartialEq for Hash

impl ToTypeHash for Hash