Struct wslapi::Stdio

pub struct Stdio { /* fields omitted */ }

A WslLaunch stdin, stdout, or stderr parameter

Implementations

impl Stdio

pub fn null() -> Self

This stream will be ignored. This is the equivalent of attaching the stream to /dev/null

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self>

Stream data from a temporary file containing the contents of bytes

pub fn from_file(file: File) -> Result<Self>

Stream data from or into a file handle

pub unsafe fn from_handle(handle: HANDLE) -> Self

Take ownership of a raw handle

Safety

handle is assumed to be "valid". That is:

• CloseHandle(handle) must be sound when Stdio is Dropped
• WslLaunch(..., handle, ...) must be legal for stdIn, stdOut, or stdErr
• The handle must be inheritable without CreateProcess's bInheritHandles=TRUE
• NULL is also legal

pub unsafe fn from_as_raw_handle(owner: impl AsRawHandle + 'static) -> Self

Take ownership of something with a raw handle

Safety

owner.as_raw_handle() is assumed to be "valid". That is:

• WslLaunch(..., owner.as_raw_handle(), ...) must be legal for stdIn, stdOut, or stdErr
• The handle must be inheritable without CreateProcess's bInheritHandles=TRUE

pub fn as_raw_handle(&self) -> RawHandle

Get a standard std::os::windows::{io::RawHandle / raw::HANDLE}

pub fn as_winapi_handle(&self) -> HANDLE

Get a winapi::shared::ntdef::HANDLE

Trait Implementations

impl AsRawHandle for Stdio

fn as_raw_handle(&self) -> RawHandle

Extracts the raw handle, without taking any ownership.

impl From<()> for Stdio

fn from(_value: ()) -> Self

Performs the conversion.

impl<'_> TryFrom<&'_ [u8]> for Stdio

fn try_from(value: &[u8]) -> Result<Self>

Performs the conversion.

type Error = Error

The type returned in the event of a conversion error.

impl<'_> TryFrom<&'_ str> for Stdio

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<File> for Stdio

fn try_from(value: File) -> Result<Self>

Performs the conversion.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<String> for Stdio

fn try_from(value: String) -> Result<Self>

Performs the conversion.

type Error = Error

The type returned in the event of a conversion error.

impl TryFrom<Vec<u8>> for Stdio

fn try_from(value: Vec<u8>) -> Result<Self>

Performs the conversion.

type Error = Error

The type returned in the event of a conversion error.