Skip to main content

## Handle

# Enum Handle

Source

    pub enum Handle {
        Null,
        Pseudo(PseudoHandle),
        Thread(ThreadId),
        File(i32),
        Invalid,
    }

Expand description

Miri representation of a Windows `HANDLE`

## Variants§

§

### Null

§

### Pseudo(PseudoHandle)

§

### Thread(ThreadId)

§

### File(i32)

§

### Invalid

## Implementations§

Source§

### impl Handle

Source

#### const NULL_DISCRIMINANT: u32 = 0

Source

#### const PSEUDO_DISCRIMINANT: u32 = 1

Source

#### const THREAD_DISCRIMINANT: u32 = 2

Source

#### const FILE_DISCRIMINANT: u32 = 3

Source

#### const INVALID_DISCRIMINANT: u32 = 7

Source

#### fn discriminant(self) -> u32

Source

#### fn data(self) -> u32

Source

#### fn packed_disc_size() -> u32

Source

#### fn to_packed(self) -> u32

Converts a handle into its machine representation.

The upper `Self::packed_disc_size()` bits are used to store a discriminant corresponding to the handle variant. The remaining bits are used for the variant’s field.

None of this layout is guaranteed to applications by Windows or Miri.

Source

#### fn new(discriminant: u32, data: u32) -> Option<Self>

Source

#### fn from_packed(handle: u32) -> Option<Self>

see docs for `to_packed`

Source

#### pub fn to_scalar(self, cx: &impl HasDataLayout) -> Scalar

Source

#### fn try_from_scalar<'tcx>( handle: Scalar, cx: &MiriInterpCx<'tcx>, ) -> InterpResult<'tcx, Result<Self, HandleError>>

Convert a scalar into a structured `Handle`. Structurally invalid handles return `HandleError::InvalidHandle`. If the handle is structurally valid but semantically invalid, e.g. a for non-existent thread ID, returns `HandleError::ThreadNotFound`.

This function is deliberately private; shims should always use `read_handle`. That enforces handle validity even when Windows does not: for now, we argue invalid handles are always a bug and programmers likely want to know about them.

## Trait Implementations§

Source§

### impl Clone for Handle

Source§

#### fn clone(&self) -> Handle

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 Handle

Source§

### impl Debug for Handle

Source§

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

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

### impl Eq for Handle

Source§

### impl Hash for Handle

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 Handle

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 (const: unstable) · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl StructuralPartialEq for Handle

## Auto Trait Implementations§

§

### impl Freeze for Handle

§

### impl RefUnwindSafe for Handle

§

### impl Send for Handle

§

### impl Sync for Handle

§

### impl Unpin for Handle

§

### impl UnsafeUnpin for Handle

§

### impl UnwindSafe for Handle

## 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> Same for T

Source§

#### type Output = T

Should always be `Self`
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

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.

## Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain `repr(...)` attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes

Size for each variant:

- `Null`: 0 bytes
- `Pseudo`: 1 byte
- `Thread`: 7 bytes
- `File`: 7 bytes
- `Invalid`: 0 bytes