ProcessHandle

Struct ProcessHandle 

Source
pub struct ProcessHandle { /* private fields */ }
Expand description

ProcessManagerHandle wrapper used to interact with only one spawned process.

ProcessHandle mimics ProcessManagerHandle API, but does not require passing ProcessId as methods parameter. It can be created by ProcessManagerHandle::spawn_with_handle method or manually by ProcessHandle::new. Like a ProcessManagerHandle it can be cheaply cloned and used by many threads safely.

See ProcessManagerHandle docs for more information.

If you want to kill the child process automatically on Drop, then use the ScopedProcessHandle.

Implementations§

Source§

impl ProcessHandle

Source

pub fn new(id: ProcessId, handle: ProcessManagerHandle) -> Self

Creates a new ProcessHandle from given process identifier and manager handle.

Source

pub fn id(&self) -> &ProcessId

Returns a process identifier associated with a handle.

Source

pub async fn send_message<M>(&self, message: M) -> Result<(), WriteMessageError>
where M: Into<Message>,

Source

pub async fn subscribe_message_stream( &self, ) -> Result<impl Stream<Item = Result<Message, ReceiveMessageError>>, ReadMessageError>

Source

pub async fn get_logs_stdout( &self, query: LogsQuery, ) -> Result<Vec<String>, GetLogsError>

Source

pub async fn get_logs_stderr( &self, query: LogsQuery, ) -> Result<Vec<String>, GetLogsError>

Source

pub async fn get_process_info(&self) -> Result<ProcessInfo, GetProcessInfoError>

Source

pub fn wait( &self, poll_interval: Duration, ) -> JoinHandle<Result<ProcessInfo, GetProcessInfoError>>

Source

pub async fn kill(&self) -> Result<(), KillProcessError>

Trait Implementations§

Source§

impl Clone for ProcessHandle

Source§

fn clone(&self) -> ProcessHandle

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProcessHandle

Source§

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

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

impl From<ProcessHandle> for ScopedProcessHandle

Source§

fn from(handle: ProcessHandle) -> Self

Converts to this type from the input type.

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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V