Add documentation to os2.close

Make it explicit that using a stream after closing is like a
use-after-free bug.
This commit is contained in:
Feoramund
2024-08-25 21:07:53 -04:00
committed by Laytan
parent 8b40be50b9
commit e7d6e2d163

View File

@@ -132,6 +132,12 @@ name :: proc(f: ^File) -> string {
return _name(f)
}
/*
Close a file and its stream.
Any further use of the file or its stream should be considered to be in the
same class of bugs as a use-after-free.
*/
close :: proc(f: ^File) -> Error {
if f != nil {
return io.close(f.stream)