Struct nails::client::Child

pub struct Child {
    pub output_stream: Option<BoxStream<'static, ChildOutput>>,
    /* private fields */
}

Fields

output_stream: Option<BoxStream<'static, ChildOutput>>

A stream of outputs from the remote child process.

Similar to std::process::Child, you should take this instance to avoid partial moves: let output_stream = child.output_stream.take().unwrap();

Implementations

impl Child

pub async fn shutdown(&mut self)

Closes the write half of the connection to the server, which will trigger cancellation in well behaved servers. Because the read half of the connection will still be open, a well behaved server/Nail will render teardown information before exiting.

Dropping the Child instance also triggers cancellation, but closes both the read and write halves of the connection at the same time (which does not allow for orderly shutdown of the server).

pub async fn wait(self) -> Result<ExitCode, Error>

Wait for the Child to have exited, and return an ExitCode.

Trait Implementations

impl Drop for Child

fn drop(&mut self)

Executes the destructor for this type.