Struct PrivateChild 

pub struct PrivateChild { /* private fields */ }

A child started with a PrivateSecret on its stdin. Dropping it closes the pipe (the child’s cue to exit) and then the owned child is terminated by its own Drop.

Implementations

impl PrivateChild

pub fn spawn(command: OwnedCommand) -> Result<Self>

Start command with a fresh secret. Stdin is replaced with a pipe; the secret is written as the first line and the pipe stays open for the child’s lifetime. Put nothing secret in the arguments or environment.

pub fn spawn_with(command: OwnedCommand, secret: PrivateSecret) -> Result<Self>

spawn with a secret the caller made.

pub fn spawn_with_extra( command: OwnedCommand, secret: PrivateSecret, extra_line: Option<&str>, ) -> Result<Self>

spawn_with for a child whose handshake is more than the secret: the secret line, then extra_line (for example a path or a second key), both written before this returns. extra_line must not contain a newline; a line that does is refused with InvalidInput before the child starts.

pub fn write_line(&mut self, line: &str) -> Result<()>

Write one more line to the child’s stdin after the handshake and flush it. Fails with BrokenPipe once the stdin is closed. line must not contain a newline.

pub fn secret(&self) -> &PrivateSecret

The secret to give a ClientConfig.

pub fn child(&self) -> &OwnedChild

The owned child, for waiting, termination and the rest of its lifecycle.

pub fn child_mut(&mut self) -> &mut OwnedChild

Mutable access to the owned child.

pub fn close_stdin(&mut self)

Close the child’s stdin: the polite request to exit. Idempotent.

Trait Implementations

impl Debug for PrivateChild

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

Formats the value using the given formatter.

impl Drop for PrivateChild

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.