try-traits 0.1.1

Alternatives to std lib traits that can fail.
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

//! Try traits for [`core::hash`].
//!
//! Note that [`BuildHasher`](core::hash::BuildHasher) isn't implemented because each call to
//! `build_hasher` should return identical values.
//!
//! [`Hasher`] also was not given a `Try` variant as I can see no real use for it (and as it
//! complicates automatic implementations), , but if there's good reason for one it'll be added.
use core::hash::{Hash, Hasher};

/// The try trait for [`Hash`].
pub trait TryHash {
	/// The type returned in the event of an error.
	type Error;

	/// The fallible equivalent of [`Hash::hash`].
	fn try_hash<H: Hasher>(&self, state: &mut H) -> Result<(), Self::Error>;

	/// The fallible equivalent of [`Hash::hash_slice`].
	fn try_hash_slice<H: Hasher>(data: &[Self], state: &mut H) -> Result<(), Self::Error>
	where
		Self: Sized
	{
		for piece in data {
			piece.try_hash(state)?;
		}

		Ok(())
	}
}

impl<T: Hash> TryHash for T {
	type Error = crate::Infallible;

	#[inline]
	fn try_hash<H: Hasher>(&self, state: &mut H) -> Result<(), Self::Error> {
		Ok(self.hash(state))
	}

	#[inline]
	fn try_hash_slice<H: Hasher>(data: &[Self], state: &mut H) -> Result<(), Self::Error> {
		Ok(Self::hash_slice(data, state))
	}
}