Struct devx_cmd::Child [−][src]
pub struct Child { /* fields omitted */ }
Expand description
Wraps std::process::Child
, kills and waits for the process on Drop
.
It will log the fact that std::process::Child::kill()
was called in Drop
.
You should use Child::wait()
for the process to finish with any of the available
methods if you want to handle the error, otherwise it will be ignored.
Beware that Child
holds an invariant that is not propagated to the
type system. The invariant is that if Child
was not spawned via
Cmd::spawn_piped()
, then any methods that read the child’s stdout
will panic.
Implementations
impl Child
[src]
impl Child
[src]pub fn wait(&mut self) -> Result<()>
[src]
pub fn wait(&mut self) -> Result<()>
[src]Waits for the process to finish. Returns an error if the process has finished with non-zero exit code.
You should use this method for processes spawned via Cmd::spawn()
since the output of the command won’t be read and returned,
but just written to this process’s stdout
(as stdout
is inherited
with Cmd::spawn()
)
pub fn read_bytes(self) -> Result<Vec<u8>>
[src]
pub fn read_bytes(self) -> Result<Vec<u8>>
[src]Same as Child::read()
but reads any bytes sequence from the
child process stdout
.
Panics
Same as for Child::read()
.
pub fn read(self) -> Result<String>
[src]
pub fn read(self) -> Result<String>
[src]Waits for the process to finish and returns all that it has written
to stdout
. Returns an error if the process has finished with
non-zero exit code. Expects a valid utf8 bytes sequence (since it returns
a Rust String
), if the process is not guaranteed to output valid utf8
you might want to use Child::read_bytes()
instead.
If Cmd::log_cmd()
has been set to some log::Level
then prints captured
output via log
crate.
Panics
Panics if the process was spawned with non-piped stdout
.
This method is expected to be used only for processes spawned via
Cmd::spawn_piped()
.
pub fn read_no_wait(&mut self, ostream: Ostream) -> Result<String>
[src]
pub fn read_no_wait(&mut self, ostream: Ostream) -> Result<String>
[src]Same as Child::read()
, but doesn’t wait for the process to finish
and doesn’t take the exit status of the process into account.
pub fn read_bytes_no_wait(&mut self, ostream: Ostream) -> Result<Vec<u8>>
[src]
pub fn read_bytes_no_wait(&mut self, ostream: Ostream) -> Result<Vec<u8>>
[src]Same as Child::read_no_wait()
, but reads raw bytes.
pub fn stdout_lines(&mut self) -> impl Iterator<Item = String> + '_
[src]
pub fn stdout_lines(&mut self) -> impl Iterator<Item = String> + '_
[src]Returns an iterator over the lines of data output to stdout
by the child process.
Beware that the iterator buffers the output, thus when the it is
dropped the buffered data will be discarded and following reads
won’t restore it.
The returned line of output is logged via log
crate according to
Cmd::log_cmd()
configuration.
Panics
Panics if some std::io::Error
happens during the reading.
All invariants from Child::read_bytes()
apply here too.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Child
impl Send for Child
impl Sync for Child
impl Unpin for Child
impl UnwindSafe for Child
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more