Skip to main content

ThreadErrorMode

Struct ThreadErrorMode 

Source
pub struct ThreadErrorMode(/* private fields */);
Expand description

A thread error mode, restricted to the bits Windows accepts per thread.

Construct one from the associated constants and union, or from a raw value with from_bits.

Implementations§

Source§

impl ThreadErrorMode

Source

pub const NONE: Self

No bits set: hard errors raise the system’s dialogs.

Source

pub const FAIL_CRITICAL_ERRORS: Self

Fail calls that hit a critical error instead of raising a dialog.

Source

pub const NO_GP_FAULT_ERROR_BOX: Self

Suppress the general-protection-fault error box.

Source

pub const NO_OPEN_FILE_ERROR_BOX: Self

Suppress the file-open error box.

Source

pub const fn bits(self) -> THREAD_ERROR_MODE

The raw value, as Win32 represents it.

Source

pub const fn from_bits(bits: THREAD_ERROR_MODE) -> Result<Self, UnsupportedBits>

Build a mode from a raw value.

§Errors

Returns UnsupportedBits if bits contains anything SetThreadErrorMode does not accept. This is a rejection rather than a mask: silently dropping a bit would report installing a value that was not installed, which is the failure this type exists to prevent.

§Example
use windows_thread_ambient_sys::ThreadErrorMode;

assert_eq!(
    ThreadErrorMode::from_bits(0x0001),
    Ok(ThreadErrorMode::FAIL_CRITICAL_ERRORS)
);

// 0x0004 is SEM_NOALIGNMENTFAULTEXCEPT, which cannot be set per thread.
// It is refused even beside a valid bit, because Windows would install
// neither: an invalid bit fails the whole call.
let refused = ThreadErrorMode::from_bits(0x0001 | 0x0004)
    .expect_err("the alignment bit is not settable per thread");
assert_eq!(refused.bits(), 0x0004);
Source

pub const fn union(self, other: Self) -> Self

Both modes’ bits.

Source

pub const fn contains(self, other: Self) -> bool

Whether every bit of other is set.

Source

pub const fn is_empty(self) -> bool

Whether no bits are set.

Source

pub fn capture() -> Result<Self, UnsupportedBits>

Read the calling thread’s current mode.

§Errors

Returns UnsupportedBits if Windows reports a bit this type cannot hold. Measured, that does not happen: the thread error mode is independent storage rather than a view of the process error mode, so a process-scope bit such as SEM_NOALIGNMENTFAULTEXCEPT does not show through here. The result is still surfaced rather than assumed away, because a type unable to represent a state the platform can produce would be a bug, and this is where that would first be observable.

Source

pub fn apply(self) -> Result<ErrorModeGuard, ApplyError>

Install this mode on the calling thread until the guard is released.

§Errors

Returns ApplyError if Windows refuses the value, in which case nothing was installed and the thread is untouched.

Trait Implementations§

Source§

impl Clone for ThreadErrorMode

Source§

fn clone(&self) -> ThreadErrorMode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ThreadErrorMode

Source§

impl Debug for ThreadErrorMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ThreadErrorMode

Source§

fn default() -> ThreadErrorMode

Returns the “default value” for a type. Read more
Source§

impl Display for ThreadErrorMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ThreadErrorMode

Source§

impl Hash for ThreadErrorMode

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ThreadErrorMode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ThreadErrorMode

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.