Library guide · API index and notation
This page is generated from the bundled library in this checkout. Signatures and adjacent source comments are reproduced below; the linked guide explains usage, storage, failures, and platform support.
import "std/process/windows"
This is a provider or implementation package. Start with the linked guide’s application API; native declarations depend on the selected target.
Names used in signatures
Unqualified names denote this package’s types (including other source files in the same package), language built-ins, or generic parameters such as T. Qualified names use the import aliases below. These aliases belong to the library source; import a dependency yourself to use its alias in your program.
| Alias | Package | Source file |
|---|---|---|
error |
std/platform/error |
windows.dodo |
io |
std/io |
windows.dodo |
native |
std/platform/native |
windows.dodo |
ptr |
core/ptr |
windows.dodo |
from_code
Function · Source
pub fn from_code(code: i32) -> error.Error
Status
Struct · Source
pub struct Status {
pub kind: i32
pub code: i32
}
Collected
Struct · Source
pub struct Collected {
pub output_len: usize
pub error_len: usize
}
CollectFailure
Struct · Source
pub struct CollectFailure {
pub cause: error.Error
pub output_len: usize
pub error_len: usize
}
State
Struct · Source
pub struct State {
// Private implementation fields omitted.
}
State.status
Function · Source
pub fn status(&self) -> Status
State.is_done
Function · Source
pub fn is_done(&self) -> bool
State.wait
Function · Source
pub fn wait(&mut self, timeout_ms: u64) -> void!error.Error
State.terminate
Function · Source
pub fn terminate(&mut self) -> void!error.Error
State.cancel
Function · Source
pub fn cancel(&mut self) -> void!error.Error
State.take_stdin
Function · Source
pub fn take_stdin(&mut self) -> Option<native.Handle>
State.take_stdout
Function · Source
pub fn take_stdout(&mut self) -> Option<native.Handle>
State.take_stderr
Function · Source
pub fn take_stderr(&mut self) -> Option<native.Handle>
State.collect
Function · Source
pub fn collect(&mut self, output: &mut[u8], error_output: &mut[u8], timeout_ms: u64) -> Collected!CollectFailure
spawn
Function · Source
pub fn spawn(executable: &native.NativeString, arguments: &native.NativeList,
environment: &native.NativeList, inherit_environment: bool,
directory: Option<&native.NativeString>, input: i32, output: i32, error_output: i32,
search_path: bool) -> State!error.Error
pipe_write
Function · Source
pub unsafe fn pipe_write(handle: isize, data: &[u8]) -> usize!io.Error
Requires an unsafe context. Follow the source safety preconditions and the linked guide before calling this API.