Struct hwlocality::errors::RawHwlocError

pub struct RawHwlocError {
    pub api: &'static str,
    pub errno: Option<Errno>,
}

Raw error emitted by hwloc functions that follow the usual convention

Hwloc APIs almost always error out by returning -1 if they return an integer, or a null pointer if they return a pointer.

They may additionally change the value of errno to report additional detail about what happened.

If no additional detail is provided by the hwloc documentation, we will assume this error handling convention and report errors using the present struct. Where possible errno values are clarified in the hwloc docs, we will assume they are the only errors that can occur, translate them into a higher-level Rust errors and panic if another errno value is observed.

Fields

api: &'static str

Hwloc entry point that failed

errno: Option<Errno>

Observed errno value, if errno was set

Note that even for entry points where hwloc is documented to set errno, this member may be None on Windows. This happens because Windows has multiple implementations of its standard C library, called C RunTimes (CRTs), and getting your application to be link against the same CRT as your hwloc DLL is basically a matter of fragile guesswork…

Trait Implementations

impl Clone for RawHwlocError

fn clone(&self) -> RawHwlocError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawHwlocError

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

Formats the value using the given formatter.

impl Display for RawHwlocError

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

Formats the value using the given formatter.

impl Error for RawHwlocError

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type based access to context intended for error reports.

impl Hash for RawHwlocError

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RawHwlocError

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for RawHwlocError

impl Eq for RawHwlocError

impl StructuralPartialEq for RawHwlocError