iceoryx2-cal 0.9.0

iceoryx2: [internal] high-level traits and implementations that represents OS primitives in an exchangeable fashion
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

// Copyright (c) 2023 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

//! Creates hashes from arbitrary byte slices.
//!
//! # Example
//!
//! ```
//! use iceoryx2_cal::hash::*;
//!
//! fn create_hash<H: Hash>() {
//!     let some_text = "Hello World".to_string();
//!     let hash = H::new(some_text.as_bytes());
//!
//!     println!("Hash value: {:?}", hash.value());
//! }
//! ```

use alloc::string::String;

use iceoryx2_bb_container::semantic_string::{SemanticString, SemanticStringError};
use iceoryx2_bb_system_types::base64url::Base64Url;

pub mod recommended;
pub mod sha1;

/// Represents the value of the hash.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct HashValue {
    value: Base64Url,
}

impl HashValue {
    pub(crate) fn new(bytes: &[u8]) -> Result<HashValue, SemanticStringError> {
        Ok(Self {
            value: Base64Url::new(bytes)?,
        })
    }

    /// Returns the base64url representation of the [`HashValue`]
    pub fn as_base64url(&self) -> &Base64Url {
        &self.value
    }
}

impl From<HashValue> for String {
    fn from(value: HashValue) -> Self {
        value.as_base64url().into()
    }
}

impl From<&HashValue> for String {
    fn from(value: &HashValue) -> Self {
        value.as_base64url().into()
    }
}

/// Interface to generate hashes.
pub trait Hash {
    /// Creates a new hash from `bytes`.
    fn new(bytes: &[u8]) -> Self;

    /// Returns the value of the [`Hash`]
    fn value(&self) -> HashValue;
}