Struct libuv::handles::process::ProcessHandle

pub struct ProcessHandle { /* fields omitted */ }

Process handles will spawn a new process and allow the user to control it and establish communication channels with it using streams.

Implementations

impl ProcessHandle

pub fn new() -> Result<ProcessHandle>

Create a new process handle

pub fn disable_stdio_inheritance()

Disables inheritance for file descriptors / handles that this process inherited from its parent. The effect is that child processes spawned by this process don’t accidentally inherit these handles.

It is recommended to call this function as early in your program as possible, before the inherited file descriptors can be closed or duplicated.

Note: This function works on a best-effort basis: there is no guarantee that libuv can discover all file descriptors that were inherited. In general it does a better job on Windows than it does on Unix.

pub fn spawn(
    &mut self,
    r#loop: &Loop,
    options: ProcessOptions<'_>
) -> Result<(), Box<dyn Error>>

Initializes the process handle and starts the process.

Possible reasons for failing to spawn would include (but not be limited to) the file to execute not existing, not having permissions to use the setuid or setgid specified, or not having enough memory to allocate for the new process.

pub fn pid(&self) -> i32

The PID of the spawned process. It’s set after calling spawn().

pub fn kill(&mut self, signum: i32) -> Result<()>

Sends the specified signal to the given process handle. Check the documentation on SignalHandle for signal support, specially on Windows.

pub fn kill_pid(pid: i32, signum: i32) -> Result<()>

Sends the specified signal to the given PID. Check the documentation on SignalHandle for signal support, specially on Windows.

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 Copy for ProcessHandle

impl From<ProcessHandle> for Handle

fn from(process: ProcessHandle) -> Handle

Performs the conversion.

impl HandleTrait for ProcessHandle

fn is_active(&self) -> bool

Returns non-zero if the handle is active, zero if it’s inactive. What “active” means depends on the type of handle: * An AsyncHandle is always active and cannot be deactivated, except by closing it with close(). * A PipeHandle, TcpHandle, UdpHandle, etc. - basically any handle that deals with i/o - is active when it is doing something that involves i/o, like reading, writing, connecting, accepting new connections, etc. * A CheckHandle, IdleHandle, TimerHandle, etc. is active when it has been started with a call to start().

fn is_closing(&self) -> bool

Returns non-zero if the handle is closing or closed, zero otherwise.

fn close<CB: Into<CloseCB<'static>>>(&mut self, cb: CB)

Request handle to be closed. close_cb will be called asynchronously after this call. This MUST be called on each handle before memory is released. Moreover, the memory can only be released in close_cb or after it has returned.

fn ref(&mut self)

Reference the given handle. References are idempotent, that is, if a handle is already referenced calling this function again will have no effect.

fn unref(&mut self)

Un-reference the given handle. References are idempotent, that is, if a handle is not referenced calling this function again will have no effect.

fn has_ref(&self) -> bool

Returns true if the handle referenced, zero otherwise.

fn send_buffer_size(&mut self, value: i32) -> Result<i32>

Gets or sets the size of the send buffer that the operating system uses for the socket.

fn recv_buffer_size(&mut self, value: i32) -> Result<i32>

Gets or sets the size of the receive buffer that the operating system uses for the socket.

fn get_fileno(&self) -> Result<OsFile>

Gets the platform dependent file descriptor equivalent.

fn get_loop(&self) -> Loop

Returns the Loop associated with this handle.

fn get_type(&self) -> HandleType

Returns the type of the handle.

impl ToHandle for ProcessHandle

fn to_handle(&self) -> Handle

impl TryFrom<Handle> for ProcessHandle

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(handle: Handle) -> Result<Self, Self::Error>

Performs the conversion.