Struct BorrowedProcess 

pub struct BorrowedProcess<'a>(/* private fields */);

Available on Windows only.

A struct representing a running process. This struct does NOT own the underlying process handle (see also OwnedProcess for an owned version).

Note

The underlying handle has the following privileges:

• PROCESS_CREATE_THREAD
• PROCESS_QUERY_INFORMATION
• PROCESS_VM_OPERATION
• PROCESS_VM_WRITE
• PROCESS_VM_READ

Implementations

impl<'a> BorrowedProcess<'a>

pub fn try_to_owned(&self) -> Result<OwnedProcess, Error>

Tries to create a new OwnedProcess instance for this process.

pub fn module_handles( &self, ) -> Result<impl ExactSizeIterator<Item = ModuleHandle>, Error>

Returns a snapshot of the handles of the modules currently loaded in this process.

Note

If the process is currently starting up and has not yet loaded all its modules, the returned list may be incomplete. This can be worked around by repeatedly calling this method.

Trait Implementations

impl AsHandle for BorrowedProcess<'_>

fn as_handle(&self) -> BorrowedHandle<'_>

Borrows the handle.

impl AsRawHandle for BorrowedProcess<'_>

fn as_raw_handle(&self) -> HANDLE

Extracts the raw handle.

impl<'a> Clone for BorrowedProcess<'a>

fn clone(&self) -> BorrowedProcess<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for BorrowedProcess<'a>

impl<'a> Debug for BorrowedProcess<'a>

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

Formats the value using the given formatter.

impl Eq for BorrowedProcess<'_>

impl<'a> From<&'a OwnedProcess> for BorrowedProcess<'a>

fn from(process: &'a OwnedProcess) -> Self

Converts to this type from the input type.

impl Hash for BorrowedProcess<'_>

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<BorrowedProcess<'_>> for OwnedProcess

fn eq(&self, other: &BorrowedProcess<'_>) -> 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<'a, 'b> PartialEq<BorrowedProcess<'a>> for BorrowedProcess<'b>

fn eq(&self, other: &BorrowedProcess<'a>) -> 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 PartialEq<OwnedProcess> for BorrowedProcess<'_>

fn eq(&self, other: &OwnedProcess) -> 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<'a> Process for BorrowedProcess<'a>

type Handle = BorrowedHandle<'a>

The underlying handle type.

fn borrowed(&self) -> BorrowedProcess<'a>

Returns a borrowed instance of this process.

fn into_handle(self) -> Self::Handle

Returns the underlying process handle.

fn try_clone(&self) -> Result<Self, Error>

Tries to clone this process into a new instance.

unsafe fn from_handle_unchecked(handle: Self::Handle) -> Self

Creates a new instance from the given handle.

fn current_handle() -> Self::Handle

Returns the pseudo handle representing the current process.

fn find_module_by_name( &self, module_name: impl AsRef<Path>, ) -> Result<Option<ProcessModule<BorrowedProcess<'a>>>, Error>

Searches the modules in this process for one with the given name. The comparison of names is case-insensitive. If the extension is omitted, the default library extension .dll is appended.

fn find_module_by_path( &self, module_path: impl AsRef<Path>, ) -> Result<Option<ProcessModule<BorrowedProcess<'a>>>, Error>

Searches the modules in this process for one with the given path. The comparison of paths is case-insensitive. If the extension is omitted, the default library extension .dll is appended.

fn wait_for_module_by_name( &self, module_name: impl AsRef<Path>, timeout: Duration, ) -> Result<Option<ProcessModule<BorrowedProcess<'a>>>, Error>

Searches the modules in this process for one with the given name, repeatedly until a matching module is found or the given timeout elapses. The comparison of names is case-insensitive. If the extension is omitted, the default library extension .dll is appended.

fn wait_for_module_by_path( &self, module_path: impl AsRef<Path>, timeout: Duration, ) -> Result<Option<ProcessModule<BorrowedProcess<'a>>>, Error>

Searches the modules in this process for one with the given path, repeatedly until a matching module is found or the given timeout elapses. The comparison of paths is case-insensitive. If the extension is omitted, the default library extension .dll is appended.

fn raw_current_handle() -> ProcessHandle

Returns the raw pseudo handle representing the current process.

fn current() -> Self

where Self: Sized,

Returns an instance representing the current process.

fn is_current(&self) -> bool

Returns whether this instance represents the current process.

fn is_alive(&self) -> bool

Returns whether this process is still alive and running.

fn pid(&self) -> Result<NonZeroU32, Error>

Returns the id of this process.

fn runs_under_wow64(&self) -> Result<bool, Error>

Returns whether this process is running under WOW64. This is the case for 32-bit programs running on a 64-bit platform.

fn is_x64(&self) -> Result<bool, Error>

Returns whether this process is a 64-bit process.

fn is_x86(&self) -> Result<bool, Error>

Returns whether this process is a 32-bit process.

fn path(&self) -> Result<PathBuf, Error>

Returns the executable path of this process.

fn base_name(&self) -> Result<OsString, Error>

Returns the file name of the executable of this process.

fn kill(&self) -> Result<(), Error>

Terminates this process with exit code 1.

fn kill_with_exit_code(&self, exit_code: u32) -> Result<(), Error>

Terminates this process with the given exit code.

fn run_remote_thread<T>( &self, remote_fn: extern "system" fn(*mut T) -> u32, parameter: *mut T, ) -> Result<u32, Error>

Starts a new thread in this process with the given entry point and argument, and waits for it to finish, returning the exit code.

fn start_remote_thread<T>( &self, remote_fn: unsafe extern "system" fn(*mut T) -> u32, parameter: *mut T, ) -> Result<OwnedHandle, Error>

Starts a new thread in this process with the given entry point and argument and returns the thread handle.

fn modules(&self) -> Result<Vec<ProcessModule<Self>>, Error>

where Self: Sized,

Returns a snapshot of all modules currently loaded in this process.

impl Send for BorrowedProcess<'_>

impl Sync for BorrowedProcess<'_>

impl TryFrom<BorrowedProcess<'_>> for OwnedProcess

type Error = Error

The type returned in the event of a conversion error.

fn try_from(process: BorrowedProcess<'_>) -> Result<Self, Self::Error>

Performs the conversion.