Struct ProcessHandle

pub struct ProcessHandle { /* private fields */ }

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.

Implementations

impl ProcessHandle

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

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

pub fn id(&self) -> &ProcessId

Returns a process identifier associated with a handle.

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

where M: Into<Message>,

See ProcessManagerHandle::send_message docs.

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

See ProcessManagerHandle::subscribe_message_stream docs.

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

See ProcessManagerHandle::get_logs_stdout docs.

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

See ProcessManagerHandle::get_logs_stderr docs.

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

See ProcessManagerHandle::get_process_info docs.

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

See ProcessManagerHandle::wait docs.

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

See ProcessManagerHandle::kill docs.

Trait Implementations

impl Clone for ProcessHandle

fn clone(&self) -> ProcessHandle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProcessHandle

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

Formats the value using the given formatter.