hare

commit 9add014b286118bd2e0a0b9c0e9e1c1e9aa095ce
parent e930456f629d14372d17e9a09c9f07ab232d715b
Author: Drew DeVault <sir@cmpwn.com>
Date:   Wed, 24 Feb 2021 11:45:04 -0500

fs::fs: update docs

Diffstat:
M
fs/types.ha
 | 
4
+++-

1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/fs/types.ha b/fs/types.ha
@@ -120,7 +120,9 @@ export type iterfunc = fn(fs: *fs, path: path) (*iterator | error);
 export type statfunc = fn(fs: *fs, path: path) (filestat | error);
 export type subdirfunc = fn(fs: *fs, path: path) (*fs | error);
 
-// An abstract implementation of a filesystem.
+// An abstract implementation of a filesystem. To create a custom stream, embed
+// this type as the first member of a struct with user-specific data and fill
+// out these fields as appropriate.
 export type fs = struct {
 	// Frees resources associated with this filesystem.
 	close: nullable *closefunc,