pub trait Hash {
// Required method
fn hash<H>(&self, state: &mut H)
where H: Hasher;
// Provided method
fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher,
Self: Sized { ... }
}
mtls
only.Expand description
A hashable type.
Types implementing Hash
are able to be hash
ed with an instance of
Hasher
.
§Implementing Hash
You can derive Hash
with #[derive(Hash)]
if all fields implement Hash
.
The resulting hash will be the combination of the values from calling
hash
on each field.
#[derive(Hash)]
struct Rustacean {
name: String,
country: String,
}
If you need more control over how a value is hashed, you can of course
implement the Hash
trait yourself:
use std::hash::{Hash, Hasher};
struct Person {
id: u32,
name: String,
phone: u64,
}
impl Hash for Person {
fn hash<H: Hasher>(&self, state: &mut H) {
self.id.hash(state);
self.phone.hash(state);
}
}
§Hash
and Eq
When implementing both Hash
and Eq
, it is important that the following
property holds:
k1 == k2 -> hash(k1) == hash(k2)
In other words, if two keys are equal, their hashes must also be equal.
HashMap
and HashSet
both rely on this behavior.
Thankfully, you won’t need to worry about upholding this property when
deriving both Eq
and Hash
with #[derive(PartialEq, Eq, Hash)]
.
Violating this property is a logic error. The behavior resulting from a logic error is not
specified, but users of the trait must ensure that such logic errors do not result in
undefined behavior. This means that unsafe
code must not rely on the correctness of these
methods.
§Prefix collisions
Implementations of hash
should ensure that the data they
pass to the Hasher
are prefix-free. That is,
values which are not equal should cause two different sequences of values to be written,
and neither of the two sequences should be a prefix of the other.
For example, the standard implementation of Hash
for &str
passes an extra
0xFF
byte to the Hasher
so that the values ("ab", "c")
and ("a", "bc")
hash differently.
§Portability
Due to differences in endianness and type sizes, data fed by Hash
to a Hasher
should not be considered portable across platforms. Additionally the data passed by most
standard library types should not be considered stable between compiler versions.
This means tests shouldn’t probe hard-coded hash values or data fed to a Hasher
and
instead should check consistency with Eq
.
Serialization formats intended to be portable between platforms or compiler versions should
either avoid encoding hashes or only rely on Hash
and Hasher
implementations that
provide additional guarantees.
Required Methods§
Provided Methods§
1.3.0 · sourcefn hash_slice<H>(data: &[Self], state: &mut H)
fn hash_slice<H>(data: &[Self], state: &mut H)
Feeds a slice of this type into the given Hasher
.
This method is meant as a convenience, but its implementation is
also explicitly left unspecified. It isn’t guaranteed to be
equivalent to repeated calls of hash
and implementations of
Hash
should keep that in mind and call hash
themselves
if the slice isn’t treated as a whole unit in the PartialEq
implementation.
For example, a VecDeque
implementation might naïvely call
as_slices
and then hash_slice
on each slice, but this
is wrong since the two slices can change with a call to
make_contiguous
without affecting the PartialEq
result. Since these slices aren’t treated as singular
units, and instead part of a larger deque, this method cannot
be used.
§Examples
use std::hash::{DefaultHasher, Hash, Hasher};
let mut hasher = DefaultHasher::new();
let numbers = [6, 28, 496, 8128];
Hash::hash_slice(&numbers, &mut hasher);
println!("Hash is {:x}!", hasher.finish());
Object Safety§
Implementors§
impl Hash for CliColors
impl Hash for rocket::http::Method
impl Hash for SameSite
impl Hash for StatusClass
impl Hash for Value
impl Hash for Feature
impl Hash for Sig
impl Hash for CipherSuite
tls
only.impl Hash for TraceFormat
impl Hash for Sign
impl Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::error::ErrorKind
impl Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::lib::std::cmp::Ordering
impl Hash for Infallible
impl Hash for AsciiChar
impl Hash for core::net::ip_addr::IpAddr
impl Hash for Ipv6MulticastScope
impl Hash for SocketAddr
impl Hash for core::sync::atomic::Ordering
impl Hash for std::io::error::ErrorKind
impl Hash for point_conversion_form_t
impl Hash for BigEndian
impl Hash for LittleEndian
impl Hash for Expiration
impl Hash for PollNext
impl Hash for ErrorLevel
impl Hash for InlinableString
impl Hash for fsconfig_command
impl Hash for membarrier_cmd
impl Hash for membarrier_cmd_flag
impl Hash for log::Level
impl Hash for log::LevelFilter
impl Hash for Direction
impl Hash for rustls_pki_types::server_name::IpAddr
impl Hash for s2n_quic_core::endpoint::Location
impl Hash for Type
impl Hash for AckElicitation
impl Hash for Probe
impl Hash for ExplicitCongestionNotification
impl Hash for IpAddress
impl Hash for SocketAddress
impl Hash for IntervalSetError
impl Hash for PacketNumberSpace
impl Hash for s2n_quic_core::transmission::mode::Mode
impl Hash for Month
impl Hash for Weekday
impl Hash for winnow::error::ErrorKind
impl Hash for Attribute
impl Hash for Quirk
impl Hash for Color
impl Hash for bool
impl Hash for char
impl Hash for i8
impl Hash for i16
impl Hash for i32
impl Hash for i64
impl Hash for i128
impl Hash for isize
impl Hash for !
impl Hash for str
impl Hash for u8
impl Hash for u16
impl Hash for u32
impl Hash for u64
impl Hash for u128
impl Hash for ()
impl Hash for usize
impl Hash for rocket::config::Level
impl Hash for ByteUnit
impl Hash for Empty
impl Hash for rocket::form::name::Key
impl Hash for rocket::form::name::Name
impl Hash for NameBuf<'_>
impl Hash for NameView<'_>
impl Hash for ContentType
impl Hash for MediaType
impl Hash for RawStr
impl Hash for RawStrBuf
impl Hash for Status
impl Hash for Uncased<'_>
impl Hash for UncasedStr
impl Hash for Absolute<'_>
impl Hash for Asterisk
impl Hash for rocket::http::uri::Authority<'_>
impl Hash for Host<'_>
impl Hash for Origin<'_>
impl Hash for rocket::http::uri::Path<'_>
impl Hash for Query<'_>
impl Hash for Reference<'_>
impl Hash for Event
impl Hash for Braced
impl Hash for Hyphenated
impl Hash for Simple
impl Hash for Urn
impl Hash for rocket::serde::uuid::Error
impl Hash for Uuid
impl Hash for rocket::trace::LevelFilter
impl Hash for RequestId
trace
only.impl Hash for ASN1Time
impl Hash for BigInt
impl Hash for BigUint
impl Hash for Layout
impl Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::lib::std::fmt::Error
impl Hash for RangeFull
impl Hash for String
impl Hash for CString
impl Hash for TypeId
impl Hash for CStr
impl Hash for PhantomPinned
impl Hash for core::net::ip_addr::Ipv4Addr
impl Hash for core::net::ip_addr::Ipv6Addr
impl Hash for SocketAddrV4
impl Hash for SocketAddrV6
impl Hash for Alignment
impl Hash for core::time::Duration
impl Hash for OsStr
impl Hash for OsString
impl Hash for FileType
impl Hash for std::os::unix::net::ucred::UCred
impl Hash for std::path::Path
impl Hash for PathBuf
impl Hash for PrefixComponent<'_>
impl Hash for ThreadId
impl Hash for std::time::Instant
impl Hash for SystemTime
impl Hash for aead::Error
impl Hash for bytes::bytes::Bytes
impl Hash for BytesMut
impl Hash for ObjectIdentifier
impl Hash for Encoding
impl Hash for Profile
impl Hash for Tag
impl Hash for h2::share::StreamId
impl Hash for Code
impl Hash for h3::proto::stream::StreamId
impl Hash for HeaderName
impl Hash for HeaderValue
impl Hash for http::method::Method
impl Hash for StatusCode
impl Hash for http::uri::authority::Authority
Case-insensitive hashing
§Examples
let a: Authority = "HELLO.com".parse().unwrap();
let b: Authority = "hello.coM".parse().unwrap();
let mut s = DefaultHasher::new();
a.hash(&mut s);
let a = s.finish();
let mut s = DefaultHasher::new();
b.hash(&mut s);
let b = s.finish();
assert_eq!(a, b);
impl Hash for PathAndQuery
impl Hash for Scheme
Case-insensitive hashing
impl Hash for Uri
impl Hash for Version
impl Hash for HttpDate
impl Hash for ReasonPhrase
impl Hash for InlineString
impl Hash for Mime
impl Hash for mio::token::Token
impl Hash for ByteBuf
impl Hash for CreateFlags
impl Hash for ReadFlags
impl Hash for WatchFlags
impl Hash for Access
impl Hash for AtFlags
impl Hash for FallocateFlags
impl Hash for MemfdFlags
impl Hash for rustix::backend::fs::types::Mode
impl Hash for OFlags
impl Hash for RenameFlags
impl Hash for ResolveFlags
impl Hash for SealFlags
impl Hash for StatVfsMountFlags
impl Hash for StatxFlags
impl Hash for Errno
impl Hash for DupFlags
impl Hash for FdFlags
impl Hash for ReadWriteFlags
impl Hash for MountFlags
impl Hash for MountPropagationFlags
impl Hash for UnmountFlags
impl Hash for XattrFlags
impl Hash for Opcode
impl Hash for Gid
impl Hash for Uid
impl Hash for rustls_pki_types::server_name::Ipv4Addr
impl Hash for rustls_pki_types::server_name::Ipv6Addr
impl Hash for TryFromIntError
impl Hash for i24
impl Hash for i48
impl Hash for u24
impl Hash for u48
impl Hash for s2n_codec::zerocopy::I16
impl Hash for s2n_codec::zerocopy::I32
impl Hash for s2n_codec::zerocopy::I64
impl Hash for s2n_codec::zerocopy::I128
impl Hash for s2n_codec::zerocopy::U16
impl Hash for s2n_codec::zerocopy::U32
impl Hash for s2n_codec::zerocopy::U64
impl Hash for s2n_codec::zerocopy::U128
impl Hash for s2n_quic_core::application::server_name::ServerName
impl Hash for InitialId
impl Hash for LocalId
impl Hash for PeerId
impl Hash for UnboundedId
impl Hash for s2n_quic_core::counter::Saturating
impl Hash for s2n_quic_core::crypto::packet_protection::Error
impl Hash for s2n_quic_core::crypto::tls::error::Error
impl Hash for EtherType
impl Hash for s2n_quic_core::inet::ethernet::Header
impl Hash for MacAddress
impl Hash for Protocol
impl Hash for FlagFragment
impl Hash for s2n_quic_core::inet::ipv4::Header
impl Hash for IpV4Address
impl Hash for SocketAddressV4
impl Hash for Tos
impl Hash for Vihl
impl Hash for s2n_quic_core::inet::ipv6::Header
impl Hash for IpV6Address
impl Hash for SocketAddressV6
impl Hash for Vtcfl
impl Hash for s2n_quic_core::inet::udp::Header
impl Hash for PacketNumber
impl Hash for PacketNumberLen
impl Hash for TruncatedPacketNumber
impl Hash for s2n_quic_core::path::Id
impl Hash for LocalAddress
impl Hash for RemoteAddress
impl Hash for PacketInfo
impl Hash for RttEstimator
impl Hash for s2n_quic_core::stateless_reset::token::Token
impl Hash for s2n_quic_core::stream::id::StreamId
impl Hash for s2n_quic_core::time::timestamp::Timestamp
impl Hash for VarInt
impl Hash for Connect
impl Hash for Map<String, Value>
impl Hash for Number
impl Hash for SigId
impl Hash for SockAddr
impl Hash for Date
impl Hash for time::duration::Duration
impl Hash for ComponentRange
impl Hash for time::instant::Instant
impl Hash for OffsetDateTime
impl Hash for PrimitiveDateTime
impl Hash for Time
impl Hash for UtcOffset
impl Hash for AnyDelimiterCodec
impl Hash for BytesCodec
impl Hash for LinesCodec
impl Hash for tokio::net::unix::ucred::UCred
impl Hash for SignalKind
impl Hash for tokio::time::instant::Instant
impl Hash for TomlError
impl Hash for InternalString
impl Hash for toml_edit::key::Key
impl Hash for RawString
impl Hash for Decor
impl Hash for Repr
impl Hash for Identifier
impl Hash for Field
impl Hash for tracing_core::span::Id
impl Hash for tracing::span::Span
impl Hash for ATerm
impl Hash for B0
impl Hash for B1
impl Hash for Z0
impl Hash for Equal
impl Hash for Greater
impl Hash for Less
impl Hash for UTerm
impl Hash for uuid::timestamp::Timestamp
impl Hash for BStr
impl Hash for winnow::stream::Bytes
impl Hash for Condition
impl Hash for Style
impl<'a> Hash for Component<'a>
impl<'a> Hash for Prefix<'a>
impl<'a> Hash for rustls_pki_types::server_name::ServerName<'a>
impl<'a> Hash for IpAddressRef<'a>
impl<'a> Hash for SocketAddressRef<'a>
impl<'a> Hash for Oid<'a>
impl<'a> Hash for core::panic::location::Location<'a>
impl<'a> Hash for Metadata<'a>
impl<'a> Hash for MetadataBuilder<'a>
impl<'a> Hash for mime::Name<'a>
impl<'a> Hash for pear::input::text::Span<'a>
impl<'a> Hash for rmp::decode::bytes::Bytes<'a>
impl<'a> Hash for DnsName<'a>
impl<'a> Hash for DecoderBuffer<'a>
impl<'a> Hash for DecoderBufferMut<'a>
impl<'a> Hash for EncryptedPayload<'a>
impl<'a> Hash for ProtectedPayload<'a>
impl<'a, SupportedVersions> Hash for VersionNegotiation<'a, SupportedVersions>where
SupportedVersions: Hash,
impl<'h> Hash for rocket::http::Header<'h>
impl<'k> Hash for KeyMut<'k>
impl<'s, T> Hash for SliceVec<'s, T>where
T: Hash,
impl<A> Hash for TinyVec<A>
impl<A> Hash for SmallVec<A>
impl<A> Hash for ArrayVec<A>
impl<A, B> Hash for figment::value::magic::Either<A, B>
impl<B> Hash for Cow<'_, B>
impl<B, C> Hash for ControlFlow<B, C>
impl<Dyn> Hash for DynMetadata<Dyn>where
Dyn: ?Sized,
impl<F> Hash for Fwhere
F: FnPtr,
impl<Idx> Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::lib::std::ops::Range<Idx>where
Idx: Hash,
impl<Idx> Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::lib::std::ops::RangeFrom<Idx>where
Idx: Hash,
impl<Idx> Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::lib::std::ops::RangeInclusive<Idx>where
Idx: Hash,
impl<Idx> Hash for RangeTo<Idx>where
Idx: Hash,
impl<Idx> Hash for RangeToInclusive<Idx>where
Idx: Hash,
impl<Idx> Hash for core::range::Range<Idx>where
Idx: Hash,
impl<Idx> Hash for core::range::RangeFrom<Idx>where
Idx: Hash,
impl<Idx> Hash for core::range::RangeInclusive<Idx>where
Idx: Hash,
impl<K, V> Hash for indexmap::map::slice::Slice<K, V>
impl<K, V, A> Hash for BTreeMap<K, V, A>
impl<L, R> Hash for either::Either<L, R>
impl<O> Hash for F32<O>where
O: Hash,
impl<O> Hash for F64<O>where
O: Hash,
impl<O> Hash for zerocopy::byteorder::I16<O>where
O: Hash,
impl<O> Hash for zerocopy::byteorder::I32<O>where
O: Hash,
impl<O> Hash for zerocopy::byteorder::I64<O>where
O: Hash,
impl<O> Hash for zerocopy::byteorder::I128<O>where
O: Hash,
impl<O> Hash for zerocopy::byteorder::U16<O>where
O: Hash,
impl<O> Hash for zerocopy::byteorder::U32<O>where
O: Hash,
impl<O> Hash for zerocopy::byteorder::U64<O>where
O: Hash,
impl<O> Hash for zerocopy::byteorder::U128<O>where
O: Hash,
impl<PacketInfo> Hash for SentPacketInfo<PacketInfo>where
PacketInfo: Hash,
impl<Ptr> Hash for Pin<Ptr>
impl<S: Hash, E: Hash, F: Hash> Hash for Outcome<S, E, F>
impl<Storage> Hash for aws_lc_sys::x86_64_unknown_linux_gnu_crypto::__BindgenBitfieldUnit<Storage>where
Storage: Hash,
impl<Storage> Hash for linux_raw_sys::general::__BindgenBitfieldUnit<Storage>where
Storage: Hash,
impl<T> Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::lib::std::ops::Bound<T>where
T: Hash,
impl<T> Hash for Option<T>where
T: Hash,
impl<T> Hash for Poll<T>where
T: Hash,
impl<T> Hash for intrusive_collections::Bound<T>where
T: Hash,
impl<T> Hash for *const Twhere
T: ?Sized,
impl<T> Hash for *mut Twhere
T: ?Sized,
impl<T> Hash for &T
impl<T> Hash for &mut T
impl<T> Hash for [T]where
T: Hash,
impl<T> Hash for (T₁, T₂, …, Tₙ)
This trait is implemented for tuples up to twelve items long.
impl<T> Hash for Reverse<T>where
T: Hash,
impl<T> Hash for Discriminant<T>
impl<T> Hash for ManuallyDrop<T>
impl<T> Hash for PhantomData<T>where
T: ?Sized,
impl<T> Hash for NonZero<T>where
T: ZeroablePrimitive + Hash,
impl<T> Hash for core::num::saturating::Saturating<T>where
T: Hash,
impl<T> Hash for Wrapping<T>where
T: Hash,
impl<T> Hash for NonNull<T>where
T: ?Sized,
impl<T> Hash for CachePadded<T>where
T: Hash,
impl<T> Hash for AllowStdIo<T>where
T: Hash,
impl<T> Hash for indexmap::set::slice::Slice<T>where
T: Hash,
impl<T> Hash for Ratio<T>
impl<T> Hash for Interval<T>where
T: Hash,
impl<T> Hash for Spanned<T>where
T: Hash,
impl<T> Hash for Formatted<T>where
T: Hash,
impl<T> Hash for Unalign<T>
impl<T, A> Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::lib::std::boxed::Box<T, A>
impl<T, A> Hash for BTreeSet<T, A>
impl<T, A> Hash for LinkedList<T, A>
impl<T, A> Hash for VecDeque<T, A>
impl<T, A> Hash for rocket::mtls::x509::der_parser::asn1_rs::nom::lib::std::vec::Vec<T, A>
The hash of a vector is the same as that of the corresponding slice,
as required by the core::borrow::Borrow
implementation.
use std::hash::BuildHasher;
let b = std::hash::RandomState::new();
let v: Vec<u8> = vec![0xa8, 0x3c, 0x09];
let s: &[u8] = &[0xa8, 0x3c, 0x09];
assert_eq!(b.hash_one(v), b.hash_one(s));
impl<T, A> Hash for Rc<T, A>
impl<T, A> Hash for Arc<T, A>
impl<T, A> Hash for allocator_api2::stable::boxed::Box<T, A>
impl<T, A> Hash for allocator_api2::stable::vec::Vec<T, A>
The hash of a vector is the same as that of the corresponding slice,
as required by the core::borrow::Borrow
implementation.
#![feature(build_hasher_simple_hash_one)]
use std::hash::BuildHasher;
let b = std::collections::hash_map::RandomState::new();
let v: Vec<u8> = vec![0xa8, 0x3c, 0x09];
let s: &[u8] = &[0xa8, 0x3c, 0x09];
assert_eq!(b.hash_one(v), b.hash_one(s));
impl<T, Behavior> Hash for Counter<T, Behavior>
impl<T, E> Hash for Result<T, E>
impl<T, N> Hash for GenericArray<T, N>where
T: Hash,
N: ArrayLength<T>,
impl<T, const N: usize> Hash for [T; N]where
T: Hash,
The hash of an array is the same as that of the corresponding slice,
as required by the Borrow
implementation.
use std::hash::BuildHasher;
let b = std::hash::RandomState::new();
let a: [u8; 3] = [0xa8, 0x3c, 0x09];
let s: &[u8] = &[0xa8, 0x3c, 0x09];
assert_eq!(b.hash_one(a), b.hash_one(s));
impl<T, const N: usize> Hash for Simd<T, N>
impl<T: Hash + Send + Sync + 'static> Hash for State<T>
impl<T: Hash> Hash for Lenient<T>
impl<T: Hash> Hash for Json<T>
json
only.impl<T: Hash, const COMPACT: bool> Hash for MsgPack<T, COMPACT>
msgpack
only.