From c11d19e7590abcafca24af011bf6714909ef4032 Mon Sep 17 00:00:00 2001 From: Mark McCaskey Date: Thu, 12 Dec 2019 14:08:27 -0800 Subject: [PATCH] Add doc comments for WASI FD associated constants --- lib/wasi/src/state/mod.rs | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/lib/wasi/src/state/mod.rs b/lib/wasi/src/state/mod.rs index 04b206c30..cda73616c 100644 --- a/lib/wasi/src/state/mod.rs +++ b/lib/wasi/src/state/mod.rs @@ -122,16 +122,30 @@ pub struct Fd { pub rights_inheriting: __wasi_rights_t, pub flags: __wasi_fdflags_t, pub offset: u64, - /// Used when reopening the file on the host system + /// Flags that determine how the [`Fd`] can be used. + /// + /// Used when reopening a [`HostFile`] during [`WasiState`] deserialization. pub open_flags: u16, pub inode: Inode, } impl Fd { + /// This [`Fd`] can be used with read system calls. pub const READ: u16 = 1; + /// This [`Fd`] can be used with write system calls. pub const WRITE: u16 = 2; + /// This [`Fd`] can append in write system calls. Note that the append + /// permission implies the write permission. pub const APPEND: u16 = 4; + /// This [`Fd`] will delete everything before writing. Note that truncate + /// permissions require the write permission. + /// + /// This permission is currently unused when deserializing [`WasiState`]. pub const TRUNCATE: u16 = 8; + /// This [`Fd`] may create a file before writing to it. Note that create + /// permissions require write permissions. + /// + /// This permission is currently unused when deserializing [`WasiState`]. pub const CREATE: u16 = 16; }