Struct paranoid_hash::ParanoidHash

pub struct ParanoidHash { /* private fields */ }

SecureHash Hashing Constructor

This struct is used to get the configuration for hashing

Implementations

impl ParanoidHash

pub fn new(digest: usize, os_hash: OsAlgorithm) -> Self

New Hasher

This method allows you to construct the hasher.

It accepts the following:

• BLAKE2B Digest Size In Bytes [1-64]
• Operating System Hash Function {SHA1,SHA256,SHA512}

You can choose to use the default if you want optimal security.

Example Code

use paranoid_hash::{ParanoidHash,OsAlgorithm};
 
fn main(){
    let context = ParanoidHash::new(64,OsAlgorithm::SHA256);
}

pub fn read<T: AsRef<Path>>(
    &self,
    path: T
) -> Result<(String, String), FileError>

pub fn read_with_key<T: AsRef<Path>>(
    &self,
    path: T,
    key: &[u8]
) -> Result<(String, String), FileError>

Read With Key

This method reads the file and uses a key with the Blake2b hash function. It does not and cannot use the key with the operating system hash function.

pub fn read_using_std<T: AsRef<Path>>(
    &self,
    path: T
) -> Result<(String, String), FileError>

Read useing std::fs

This function allows you to read files using std::fs. This is rust’s default way of reading files.

pub fn read_str<T: AsRef<str>>(&self, string: T) -> (String, String)

Read String

This function will allow you to take a String or str, convert it to bytes, then hash it.

pub fn read_bytes(&self, bytes: &[u8]) -> (String, String)

Read Bytes

This function will hash bytes and return the output as two seperate strings.

pub fn decode_from_hex<T: AsRef<str>>(s: T) -> Vec<u8>

decode_from_hex()

decode_from_hex() (which was as_bytes()) converts from a Hexadecimal String to a Vector of Bytes

pub fn return_digest_size(&self) -> usize

Return Digest Size

This method will return the provided digest size that the struct contains. It should be between 1 and 64 of type usize.

pub fn return_os_hash_algorithm(&self) -> OsAlgorithm

Return Operating System Hash Function

This method will return the hash function used by the operating system that was chosen

pub fn compare_hash<T: AsRef<str>>(hash1: T, hash2: T) -> bool

Compare Hash

Notice: This function attempts to use constant-time operations in comparing strings based on this.

Description: Compares two hash functions (case-insensitive) and if they are the same, returns true. If they are different, returns false.

Trait Implementations

impl Clone for ParanoidHash

fn clone(&self) -> ParanoidHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParanoidHash

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

Formats the value using the given formatter.

impl Default for ParanoidHash

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ParanoidHash

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<ParanoidHash> for ParanoidHash

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

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

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

This method tests for !=.

impl PartialOrd<ParanoidHash> for ParanoidHash

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for ParanoidHash