From 31f7bf82711a1d971e9d786a40c01f8d7088cd52 Mon Sep 17 00:00:00 2001 From: Dan Gohman Date: Tue, 27 Jul 2021 16:59:46 -0700 Subject: [PATCH] Add a comment about `OptionFileHandle`. --- library/std/src/os/windows/io/handle.rs | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/library/std/src/os/windows/io/handle.rs b/library/std/src/os/windows/io/handle.rs index 3f9a146786c..2d561ad476a 100644 --- a/library/std/src/os/windows/io/handle.rs +++ b/library/std/src/os/windows/io/handle.rs @@ -58,6 +58,10 @@ pub struct OwnedHandle { /// where `INVALID_HANDLE_VALUE` is used as the sentry value, and null values /// are not used at all, such as in the return value of `CreateFileW`. /// +/// The main thing you can do with an `OptionFileHandle` is to convert it into +/// an `OwnedHandle` using its [`TryFrom`] implementation, and this conversion +/// takes care of the check for `INVALID_HANDLE_VALUE`. +/// /// If this holds an owned handle, it closes the handle on drop. /// /// This uses `repr(transparent)` and has the representation of a host handle, -- GitLab