Struct ring::error::Unspecified
source · pub struct Unspecified;
Expand description
An error with absolutely no details.
ring uses this unit type as the error type in most of its results because (a) usually the specific reasons for a failure are obvious or are not useful to know, and/or (b) providing more details about a failure might provide a dangerous side channel, and/or (c) it greatly simplifies the error handling logic.
Result<T, ring::error::Unspecified>
is mostly equivalent to
Result<T, ()>
. However, ring::error::Unspecified
implements
std::error::Error
and users of ring can implement
From<ring::error::Unspecified>
to map this to their own error types, as
described in “Error Handling” in the Rust Book:
use ring::rand::{self, SecureRandom};
enum Error {
CryptoError,
IOError(std::io::Error),
// [...]
}
impl From<ring::error::Unspecified> for Error {
fn from(_: ring::error::Unspecified) -> Self { Error::CryptoError }
}
fn eight_random_bytes() -> Result<[u8; 8], Error> {
let rng = rand::SystemRandom::new();
let mut bytes = [0; 8];
// The `From<ring::error::Unspecified>` implementation above makes this
// equivalent to
// `rng.fill(&mut bytes).map_err(|_| Error::CryptoError)?`.
rng.fill(&mut bytes)?;
Ok(bytes)
}
assert!(eight_random_bytes().is_ok());
Experience with using and implementing other crypto libraries like has shown that sophisticated error reporting facilities often cause significant bugs themselves, both within the crypto library and within users of the crypto library. This approach attempts to minimize complexity in the hopes of avoiding such problems. In some cases, this approach may be too extreme, and it may be important for an operation to provide some details about the cause of a failure. Users of ring are encouraged to report such cases so that they can be addressed individually.
Trait Implementations§
source§impl Clone for Unspecified
impl Clone for Unspecified
source§fn clone(&self) -> Unspecified
fn clone(&self) -> Unspecified
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for Unspecified
impl Debug for Unspecified
source§impl Display for Unspecified
impl Display for Unspecified
source§impl Error for Unspecified
impl Error for Unspecified
source§fn cause(&self) -> Option<&dyn Error>
fn cause(&self) -> Option<&dyn Error>
source§fn description(&self) -> &str
fn description(&self) -> &str
source§impl From<EndOfInput> for Unspecified
impl From<EndOfInput> for Unspecified
source§fn from(_: EndOfInput) -> Self
fn from(_: EndOfInput) -> Self
source§impl From<KeyRejected> for Unspecified
impl From<KeyRejected> for Unspecified
source§fn from(_: KeyRejected) -> Self
fn from(_: KeyRejected) -> Self
source§impl From<TryFromSliceError> for Unspecified
impl From<TryFromSliceError> for Unspecified
source§fn from(_: TryFromSliceError) -> Self
fn from(_: TryFromSliceError) -> Self
source§impl PartialEq for Unspecified
impl PartialEq for Unspecified
source§fn eq(&self, other: &Unspecified) -> bool
fn eq(&self, other: &Unspecified) -> bool
self
and other
values to be equal, and is used
by ==
.impl Copy for Unspecified
impl StructuralPartialEq for Unspecified
Auto Trait Implementations§
impl Freeze for Unspecified
impl RefUnwindSafe for Unspecified
impl Send for Unspecified
impl Sync for Unspecified
impl Unpin for Unspecified
impl UnwindSafe for Unspecified
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)