Struct Hashstring

pub struct Hashstring { /* private fields */ }

Available on crate feature hashstrings only.

The hash of a string. Can be used to search for strings without storing the string itself in memory.

Example

use encrust_core::{Hashstring, Sensitivity};

let hashstring = Hashstring::new("A string", 0xabcdef, Sensitivity::CaseSensitive);
assert!(hashstring == "A string");
assert!(hashstring != "a string");

let case_insensitive_hashstring =
    Hashstring::new("A string", 0xfedcba, Sensitivity::CaseInsensitive);
assert!(case_insensitive_hashstring == "A string");
assert!(case_insensitive_hashstring == "a string");

Implementations

impl Hashstring

pub fn new(s: &str, seed: u64, sensitivity: Sensitivity) -> Self

Create a new Hashstring using the provided string and random seed.

Note that if Sensitivity::CaseInsensitive is used, a new String is allocated with the provided s converted to lowercase. The newly allocated string is overwritten using Zeroize after calculating the hash.

This function does not zeroize the original string. To avoid ever having the string in memory, it is recommended to use the hashstring! macro.

Trait Implementations

impl PartialEq<&str> for Hashstring

fn eq(&self, other: &&str) -> 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.