Skip to content

Commit

Permalink
Add docs explaining what OsOther is
Browse files Browse the repository at this point in the history
  • Loading branch information
kubkon committed May 6, 2020
1 parent 6f0d437 commit 40a9e08
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions crates/wasi-common/src/sys/osother.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ pub(crate) trait OsOtherExt {
fn from_null() -> io::Result<Box<dyn Handle>>;
}

/// `OsOther` is something of a catch-all for everything not covered with the specific handle
/// types (`OsFile`, `OsDir`, `Stdio`). It currently encapsulates handles such as OS pipes,
/// sockets, streams, etc. As such, when redirecting stdio within `WasiCtxBuilder`, the redirected
/// pipe should be encapsulated within this instance _and not_ `OsFile` which represents a regular
/// OS file.
#[derive(Debug)]
pub(crate) struct OsOther {
file_type: Filetype,
Expand Down

0 comments on commit 40a9e08

Please sign in to comment.