Enum HashAlgo

#[repr(u16)]
pub enum HashAlgo {
    Md5 = 0,
    Sha256 = 1,
    Other = 255,
}

Supported various hash algorithms.

This enum defines the supported hash algorithms, each represented by a specific identifier (u16 value). The available algorithms include Md5, Sha256, and Other for unspecified or custom algorithms.

Variants

• Md5: MD5 hash algorithm (0x00).
• Sha256: SHA-256 hash algorithm (0x01).
• Other: Represents other custom or unsupported hash algorithms (0xFF).

Example

use amebazii::types::enums::HashAlgo;

let algo = HashAlgo::try_from(1).unwrap();
assert_eq!(algo, HashAlgo::Sha256); // Successfully converts to Sha256.

Variants

Md5 = 0

Sha256 = 1

Other = 255

Implementations

impl HashAlgo

pub fn compute_hash( &self, buffer: &[u8], key: Option<&[u8]>, ) -> Result<Vec<u8>, Error>

Computes the hash of the provided buffer using the specified algorithm.

If a key is provided, HMAC (Hash-based Message Authentication Code) is used.

Parameters

• buffer: A byte slice containing the data to be hashed.
• key: An optional byte slice containing the key for HMAC. If None, the raw hash is computed.

Returns

• Ok(Vec<u8>): The computed hash as a vector of bytes.
• Err(Error::UnsupportedHashAlgo): An error if an unsupported hash algorithm is chosen.

Example

use amebazii::types::enums::HashAlgo;

let data = b"some data to hash";
let algo = HashAlgo::Md5;
let result = algo.compute_hash(data, None).unwrap();
assert_eq!(result.len(), 16); // MD5 produces a 16-byte hash.

Trait Implementations

impl Clone for HashAlgo

fn clone(&self) -> HashAlgo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HashAlgo

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

Formats the value using the given formatter.

impl Default for HashAlgo

fn default() -> HashAlgo

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HashAlgo

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Ord for HashAlgo

fn cmp(&self, other: &HashAlgo) -> 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 for HashAlgo

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

fn partial_cmp(&self, other: &HashAlgo) -> 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 HashAlgo

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<u16> for HashAlgo

fn try_from(value: u16) -> Result<Self, Self::Error>

Tries to convert a u16 value to a corresponding HashAlgo variant.

Parameters

• value: The u16 value representing the hash algorithm.

Returns

• Ok(HashAlgo): The corresponding HashAlgo variant if the value matches.
• Err(Error::InvalidEnumValue): An error if the value doesn’t match a valid hash algorithm.

type Error = Error

The type returned in the event of a conversion error.

impl Copy for HashAlgo

impl Eq for HashAlgo

impl StructuralPartialEq for HashAlgo