Struct Error

pub struct Error(/* private field */);

A small and no_std compatible error type

The [Error::raw_os_error()] will indicate if the error is from the OS, and if so, which error code the OS gave the application. If such an error is encountered, please consult with your system documentation.

If this crate's "std" Cargo feature is enabled, then:

Implementations

impl Error

const UNSUPPORTED: Error = _;

This target/platform is not supported by getrandom.

const ERRNO_NOT_POSITIVE: Error = _;

The platform-specific errno returned a non-positive value.

const UNEXPECTED: Error = _;

Encountered an unexpected situation which should not happen in practice.

fn raw_os_error(self) -> Option<RawOsError>

Extract the raw OS error code (if this error came from the OS)

This method is identical to std::io::Error::raw_os_error(), except that it works in no_std contexts. On most targets this method returns Option<i32>, but some platforms (e.g. UEFI) may use a different primitive type like usize. Consult with the RawOsError docs for more information.

If this method returns None, the error value can still be formatted via the Display implementation.

const fn new_custom(n: u16) -> Error

Creates a new instance of an Error from a particular custom error code.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

impl Copy for Error

impl Debug for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Display for Error

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl Eq for Error

impl Error for Error

impl PartialEq for Error

fn eq(&self, other: &Error) -> bool

impl StructuralPartialEq for Error

Auto Trait Implementations

impl Freeze for Error

impl RefUnwindSafe for Error

impl Send for Error

impl Sync for Error

impl Unpin for Error

impl UnsafeUnpin for Error

impl UnwindSafe for Error

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

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

impl<T> From<T> for Error

fn from(t: T) -> T

Returns the argument unchanged.

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

type Owned = T;
fn to_owned(&self) -> T
fn clone_into(&self, target: &mut T)

impl<T> ToString for Error where T: Display + ?Sized,

fn to_string(&self) -> String

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

fn into(self) -> U

Calls U::from(self).

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

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

type Error = never;
fn try_from(value: U) -> Result<T, never>

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

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