How does Duct compare to std::process::Command in Rust?

Duct offers a higher-level, shell-like API for building pipelines and handling IO with better error handling and cross-platform consistency, while std::process::Command provides more low-level control. Use Duct for complex pipelines and std::process for simple, direct commands.

How to handle timeouts with Duct in Rust?

Duct does not have built-in timeout support; you need to implement it manually using threads or external crates like std::thread::spawn with join_timeout. This adds complexity compared to libraries with native timeout features.

Can Duct be used in async Rust applications?

Yes, but it requires workarounds since Duct is synchronous. You can run Duct commands in separate threads or use async-std/tokio to spawn blocking tasks, but this introduces overhead and potential concurrency issues.

Does Duct work well on Windows for running shell commands?

Duct is designed for portability and handles Windows-specific inconsistencies, as noted in its gotchas documentation. However, for complex shell features, you might still encounter edge cases compared to Unix-like systems.

What's the performance impact of using Duct versus manual process spawning?

Duct adds a thin abstraction layer, which may introduce minimal overhead, but its focus on correctness and error handling can improve reliability. For high-performance, low-latency applications, direct use of std::process might be slightly faster.

How to capture stdout and stderr separately with Duct?

Duct primarily supports merging stderr into stdout via .stderr_to_stdout(). For separate capture, you need to use multiple command instances or handle streams externally, as the library emphasizes pipeline simplicity over granular control.

duct.rs — Shell-Like Pipeline Library for Rust

What is duct.rs?

Duct is a Rust library for running child processes, enabling developers to build command pipelines and redirect IO with a shell-like API. It solves the problem of platform inconsistencies and error handling in process execution, providing a robust and portable alternative to manual process spawning.

Target Audience

Rust developers who need to execute external commands, build pipelines, or manage child processes in system tools, build scripts, or automation tasks.

Value Proposition

Developers choose Duct for its combination of shell-like convenience and Rust's safety guarantees, with built-in handling of common pitfalls and cross-platform inconsistencies that typically require manual workarounds.

a Rust library for running child processes

Use Cases

Best For

Building command-line tools that need to execute and chain external programs
Creating build scripts or automation tasks with complex process pipelines
Writing cross-platform system utilities that interact with child processes
Implementing process management with robust error handling and output capture
Replacing shell scripts with type-safe Rust code while maintaining pipeline expressiveness
Developing tools that require incremental reading of process output streams

Not Ideal For

Projects requiring direct, low-level control over OS-specific process APIs for fine-tuning performance or behavior
Applications where minimizing external dependencies is critical, such as embedded systems or lightweight binaries
Scenarios needing asynchronous, non-blocking process execution without manual threading or workarounds
Simple, single-command tasks where Rust's standard library std::process::Command is sufficient and more concise

Pros & Cons

Pros

Fluent Pipeline API

Enables building command pipelines with a shell-like fluent syntax, as shown in examples like cmd!("echo", "hi").pipe(cmd!("sed", "s/i/o/")), simplifying complex process chains.

Robust Error Handling

Defaults to treating non-zero exit codes as errors, promoting correct error reporting, with overrides available via .unchecked(), as demonstrated in the false command example.

Platform Consistency

Handles OS-specific inconsistencies transparently, addressing common gotchas and bugs across platforms, ensuring portable code without manual workarounds.

Whitespace Safety

Passes arguments directly without shell interpretation, eliminating whitespace-related bugs and injection vulnerabilities, a core feature highlighted in the philosophy.

Flexible IO Redirection

Supports merging stderr into stdout, incremental output reading via .reader(), and other IO controls, as illustrated in the BufReader example for streaming output.

Cons

Synchronous by Default

The API is primarily synchronous, blocking threads during process execution, which can hinder integration with async Rust runtimes and require additional complexity for non-blocking operations.

Dependency Overhead

Adds an external library dependency, increasing project size and complexity for tasks that could be handled by Rust's lighter-weight standard process utilities.

Limited Async Support

Lacks built-in asynchronous features, forcing developers to implement custom threading or rely on external crates for async process management, a gap not addressed in the README.

Frequently Asked Questions

What is duct.rs?

Target Audience

Rust developers who need to execute external commands, build pipelines, or manage child processes in system tools, build scripts, or automation tasks.

Value Proposition

Use Cases

Best For

Building command-line tools that need to execute and chain external programs
Creating build scripts or automation tasks with complex process pipelines
Writing cross-platform system utilities that interact with child processes
Implementing process management with robust error handling and output capture
Replacing shell scripts with type-safe Rust code while maintaining pipeline expressiveness
Developing tools that require incremental reading of process output streams

Not Ideal For

Projects requiring direct, low-level control over OS-specific process APIs for fine-tuning performance or behavior
Applications where minimizing external dependencies is critical, such as embedded systems or lightweight binaries
Scenarios needing asynchronous, non-blocking process execution without manual threading or workarounds
Simple, single-command tasks where Rust's standard library std::process::Command is sufficient and more concise

Pros & Cons

Pros

Fluent Pipeline API

Enables building command pipelines with a shell-like fluent syntax, as shown in examples like cmd!("echo", "hi").pipe(cmd!("sed", "s/i/o/")), simplifying complex process chains.

Robust Error Handling

Defaults to treating non-zero exit codes as errors, promoting correct error reporting, with overrides available via .unchecked(), as demonstrated in the false command example.

Platform Consistency

Handles OS-specific inconsistencies transparently, addressing common gotchas and bugs across platforms, ensuring portable code without manual workarounds.

Whitespace Safety

Passes arguments directly without shell interpretation, eliminating whitespace-related bugs and injection vulnerabilities, a core feature highlighted in the philosophy.

Flexible IO Redirection

Supports merging stderr into stdout, incremental output reading via .reader(), and other IO controls, as illustrated in the BufReader example for streaming output.

Cons

Synchronous by Default

The API is primarily synchronous, blocking threads during process execution, which can hinder integration with async Rust runtimes and require additional complexity for non-blocking operations.

Dependency Overhead

Adds an external library dependency, increasing project size and complexity for tasks that could be handled by Rust's lighter-weight standard process utilities.

Limited Async Support

Lacks built-in asynchronous features, forcing developers to implement custom threading or rely on external crates for async process management, a gap not addressed in the README.

Frequently Asked Questions

duct.rs

What is duct.rs?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

duct.rs

What is duct.rs?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?