Skip to main content

Hashed

Struct Hashed 

Source
pub struct Hashed<T: Translator> { /* private fields */ }
Expand description

Collision-resistant wrapper for any Translator.

Hashes the full key with a per-instance secret seed before delegating to the inner translator. This makes translated-key collisions unpredictable to an adversary who does not know the seed, similar to how std::collections::HashMap uses std::collections::hash_map::RandomState to prevent HashDoS attacks. It can also be used to ensure uniform distribution of skewed keyspaces when used by non-hashing structures such as crate::index.

§No Ordering

Hashing destroys lexicographic key ordering, so Hashed does not implement OrderedTranslator and cannot back an ordered index or the ordered QMDB. It is safe for unordered indices and partitioned unordered indices.

An ordered index over Hashed does not compile:

ⓘ
use commonware_storage::{
    index::{Ordered, ordered::Index},
    translator::{Hashed, TwoCap},
};

fn ordered<I: Ordered>() {}
ordered::<Index<Hashed<TwoCap>, u64>>();

§no_std Support

Hashed::new and Default are available only with this crate’s std feature. They use ahash::RandomState::new, which requires OS-provided randomness (the runtime-rng feature of ahash, enabled by std here). In no_std environments, use Hashed::from_seed with an externally-sourced random seed instead.

§No Stability Guarantees

ahash::RandomState is used as the underlying hasher. While ahash is robust, its exact algorithm might change across versions. As a result, transformed outputs are not stable across Rust versions or platforms. Treat this translator as an in-memory collision-hardening mechanism, not as a stable/persisted encoding.

§Examples

use commonware_storage::translator::{Hashed, TwoCap, Translator};

// Random seed (production use, requires `std`):
let t = Hashed::new(TwoCap);
let _k = t.transform(b"hello");

// Deterministic seed (testing within the same toolchain/runtime):
let t = Hashed::from_seed(42, TwoCap);
assert_eq!(t.transform(b"hello"), t.transform(b"hello"));

Implementations§

Source§

impl<T: Translator> Hashed<T>

Source

pub fn new(inner: T) -> Self

Create a new Hashed translator with a random seed.

Source

pub const fn from_seed(seed: u64, inner: T) -> Self

Create a new Hashed translator with a specific seed.

Trait Implementations§

Source§

impl<T: Translator> BuildHasher for Hashed<T>

Source§

type Hasher = <T as BuildHasher>::Hasher

Type of the hasher that will be created.
Source§

fn build_hasher(&self) -> Self::Hasher

Creates a new hasher. Read more
1.71.0 · Source§

fn hash_one<T>(&self, x: T) -> u64
where T: Hash, Self: Sized, Self::Hasher: Hasher,

Calculates the hash of a single value. Read more
Source§

impl<T: Clone + Translator> Clone for Hashed<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Translator + Default> Default for Hashed<T>

Available on crate feature std only.
Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<T: Translator> Translator for Hashed<T>

Source§

type Key = <T as Translator>::Key

The type of the internal representation of keys. Read more
Source§

fn transform(&self, key: &[u8]) -> T::Key

Transform a key into its new representation.

Auto Trait Implementations§

§

impl<T> Freeze for Hashed<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Hashed<T>
where T: RefUnwindSafe,

§

impl<T> Send for Hashed<T>

§

impl<T> Sync for Hashed<T>

§

impl<T> Unpin for Hashed<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Hashed<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Hashed<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Threaded<T> for T

Source§

type Rest = ()

The outputs beyond the threaded value.
Source§

fn split(self) -> (T, ())

Splits into the threaded value and the extra outputs.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more