Struct HTHREAD

pub struct HTHREAD(/* private fields */);

Available on crate feature kernel only.

Handle to a thread. Originally just a HANDLE.

Implementations

impl HTHREAD

pub fn OpenThreadToken( &self, desired_access: TOKEN, open_as_self: bool, ) -> SysResult<CloseHandleGuard<HACCESSTOKEN>>

Available on crate feature advapi only.

OpenThreadToken function.

impl HTHREAD

pub const unsafe fn from_ptr(p: *mut c_void) -> Self

Constructs a new handle object by wrapping a pointer.

This method can be used as an escape hatch to interoperate with other libraries.

Safety

Be sure the pointer has the correct type and isn’t owned by anyone else, otherwise you may cause memory access violations.

pub const unsafe fn raw_copy(&self) -> Self

Returns a raw copy of the underlying handle pointer.

Safety

As the name implies, raw_copy returns a raw copy of the handle, so closing one of the copies won’t close the others. This means a handle can be used after it has been closed, what can lead to errors and undefined behavior. Even worse: sometimes Windows reuses handle values, so you can call a method on a completely different handle type, what can be catastrophic.

However, in some cases the Windows API demands a copy of the handle – raw_copy is an escape hatch to fill this gap.

pub const unsafe fn as_mut(&mut self) -> &mut *mut c_void

Returns a mutable reference to the underlying raw pointer.

This method can be used as an escape hatch to interoperate with other libraries.

Safety

This method exposes the raw pointer used by raw Windows calls. It’s an opaque pointer to an internal Windows structure, and no dereferencings should be attempted.

pub const fn ptr(&self) -> *mut c_void

Returns the underlying raw pointer.

This method exposes the raw pointer used by raw Windows calls. It’s an opaque pointer to an internal Windows structure, and no dereferencings should be attempted.

This method can be used as an escape hatch to interoperate with other libraries.

impl HTHREAD

pub fn CreateThread( thread_attrs: Option<&mut SECURITY_ATTRIBUTES<'_>>, stack_size: usize, start_addr: *mut c_void, parameter: *mut c_void, flags: THREAD_CREATE, ) -> SysResult<(CloseHandleGuard<HTHREAD>, u32)>

CreateThread function.

Returns the thread handle and its ID.

pub fn GetCurrentThread() -> HTHREAD

GetCurrentThread function.

pub fn GetExitCodeThread(&self) -> SysResult<u32>

GetExitCodeThread function.

pub fn GetProcessIdOfThread(&self) -> SysResult<u32>

GetProcessIdOfThread function.

pub fn GetThreadId(&self) -> SysResult<u32>

GetThreadId function.

pub fn GetThreadIdealProcessorEx(&self) -> SysResult<PROCESSOR_NUMBER>

GetThreadIdealProcessorEx function.

pub fn GetThreadIOPendingFlag(&self) -> SysResult<bool>

GetThreadIOPendingFlag function.

pub fn GetThreadPriorityBoost(&self) -> SysResult<bool>

GetThreadPriorityBoost function.

pub fn GetThreadTimes( &self, ) -> SysResult<(FILETIME, FILETIME, FILETIME, FILETIME)>

GetThreadTimes function.

Returns, respectively:

1. creation time;
2. exit time;
3. kernel time;
4. user time.

Examples

use winsafe::{self as w, prelude::*, co};

let hthread: w::HTHREAD; // initialized somewhere

let (creation, exit, kernel, user) = hthread.GetThreadTimes()?;

pub fn QueryThreadCycleTime(&self) -> SysResult<u64>

QueryThreadCycleTime function.

pub fn ResumeThread(&self) -> SysResult<u32>

ResumeThread function.

pub fn SetThreadIdealProcessor(&self, ideal_processor: u32) -> SysResult<u32>

SetThreadIdealProcessor function.

Returns the previous ideal processor.

pub fn SetThreadIdealProcessorEx( &self, ideal_processor: PROCESSOR_NUMBER, ) -> SysResult<PROCESSOR_NUMBER>

SetThreadIdealProcessorEx function.

Returns the previous ideal processor.

pub fn SetThreadPriorityBoost( &self, disable_priority_boost: bool, ) -> SysResult<()>

SetThreadPriorityBoost function.

pub fn SuspendThread(&self) -> SysResult<u32>

SuspendThread function.

pub fn TerminateThread(&self, exit_code: u32) -> SysResult<()>

TerminateThread function.

Trait Implementations

impl Debug for HTHREAD

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

Formats the value using the given formatter.

impl Display for HTHREAD

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

Formats the value using the given formatter.

impl Handle for HTHREAD

const NULL: Self

The null, uninitialized handle; equals to 0.

const INVALID: Self

The invalid handle; equals to -1.

unsafe fn from_ptr(p: *mut c_void) -> Self

Constructs a new handle object by wrapping a pointer.

unsafe fn raw_copy(&self) -> Self

Returns a raw copy of the underlying handle pointer.

unsafe fn as_mut(&mut self) -> &mut *mut c_void

Returns a mutable reference to the underlying raw pointer.

fn ptr(&self) -> *mut c_void

Returns the underlying raw pointer.

fn as_opt(&self) -> Option<&Self>

Returns None if the handle is null or invalid, otherwise returns Some(&self).

impl Hash for HTHREAD

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 LowerHex for HTHREAD

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

Formats the value using the given formatter.

impl PartialEq for HTHREAD

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl UpperHex for HTHREAD

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

Formats the value using the given formatter.

impl Eq for HTHREAD

impl Send for HTHREAD

impl StructuralPartialEq for HTHREAD